From b885d25678e9340116c781c297c327b54db92d79 Mon Sep 17 00:00:00 2001 From: sequba Date: Thu, 20 Jun 2024 10:20:54 +0000 Subject: [PATCH] deploy: 458a0e459812be79719c28094358982d4512546b --- 404.html | 4 +- api-ref-readme.html | 6 +- api/classes/emitter.html | 6 +- api/classes/hyperformula.html | 260 +++++++++--------- api/enums/events.html | 6 +- api/globals.html | 6 +- api/index.html | 6 +- api/interfaces/configparams.html | 10 +- api/interfaces/listeners.html | 20 +- api/interfaces/typedemitter.html | 6 +- assets/js/{20.028dc2b5.js => 20.d1175753.js} | 4 +- assets/js/{25.9bed9b62.js => 25.f6eb2894.js} | 2 +- assets/js/{27.11b6a3ff.js => 27.1eb07f4b.js} | 2 +- assets/js/{28.9a5300e8.js => 28.a6b42c2e.js} | 2 +- assets/js/{29.d2c15be1.js => 29.bff45b76.js} | 2 +- assets/js/{30.845910cf.js => 30.70774167.js} | 2 +- assets/js/{31.edb78418.js => 31.4842ae45.js} | 2 +- assets/js/{32.51d25065.js => 32.3fb72d16.js} | 2 +- assets/js/{33.0b18acdc.js => 33.d6c827f6.js} | 2 +- assets/js/{34.61ab12b3.js => 34.e78b98bf.js} | 2 +- assets/js/{36.56a7ae41.js => 36.d2174e4f.js} | 2 +- assets/js/{37.d14d492b.js => 37.a71973b7.js} | 2 +- assets/js/{38.8f703866.js => 38.464afe70.js} | 2 +- assets/js/{39.71a01a28.js => 39.b3f3fab4.js} | 2 +- assets/js/{40.2c098a09.js => 40.c7c31d0b.js} | 2 +- assets/js/{41.42833c07.js => 41.e875b384.js} | 2 +- assets/js/{42.758cc26b.js => 42.2f924bff.js} | 2 +- assets/js/{43.446790b6.js => 43.18b61786.js} | 2 +- assets/js/{44.24f60e46.js => 44.9d686178.js} | 2 +- assets/js/{46.cdb9500c.js => 46.f2c1cd66.js} | 2 +- assets/js/{47.e4b3f370.js => 47.bb2946d5.js} | 2 +- assets/js/{48.c15683f6.js => 48.0b99222a.js} | 2 +- assets/js/{49.75c2b850.js => 49.4f1be892.js} | 2 +- assets/js/{50.43832462.js => 50.a373e841.js} | 2 +- assets/js/{51.1f0d82cb.js => 51.c86ed915.js} | 2 +- assets/js/{52.0cd5f737.js => 52.71b4d388.js} | 2 +- assets/js/53.3642c010.js | 1 - assets/js/53.fff0fdfc.js | 1 + assets/js/{54.ecf0ef7e.js => 54.0f1b03cf.js} | 2 +- assets/js/{55.63d94e73.js => 55.33186257.js} | 2 +- assets/js/{56.a2f69074.js => 56.073b63a2.js} | 2 +- assets/js/{57.22feb479.js => 57.d68070b8.js} | 2 +- assets/js/{58.b780ec13.js => 58.b81b9346.js} | 2 +- assets/js/{59.0483cbf7.js => 59.87cbf7b7.js} | 2 +- assets/js/{60.8e4e20a3.js => 60.f0b88f75.js} | 2 +- assets/js/{61.aa4e40a9.js => 61.82c62269.js} | 2 +- assets/js/{62.92b9a768.js => 62.77b1d9e4.js} | 2 +- assets/js/{63.8a709a4f.js => 63.2af032cd.js} | 2 +- assets/js/{65.e88e2c97.js => 65.4c8d33c5.js} | 2 +- assets/js/{66.b36e89fd.js => 66.715c0b5c.js} | 2 +- assets/js/{67.9a07a251.js => 67.cb024ca8.js} | 2 +- assets/js/{68.3696c8f4.js => 68.e69c4b73.js} | 2 +- assets/js/{69.36e8fc1b.js => 69.9f71d49c.js} | 2 +- assets/js/{70.5365e0f7.js => 70.db7c195e.js} | 2 +- assets/js/{71.1849dde1.js => 71.09e74e94.js} | 2 +- assets/js/{72.5ff76d95.js => 72.7f186870.js} | 2 +- assets/js/{73.c200c01d.js => 73.eb2226cd.js} | 2 +- assets/js/{74.c1180d57.js => 74.17f5f9a5.js} | 2 +- assets/js/{75.9c101195.js => 75.06b4898a.js} | 2 +- assets/js/{76.951726a1.js => 76.2c0816b0.js} | 2 +- assets/js/{77.33977693.js => 77.366a49ba.js} | 2 +- assets/js/{78.741e3ffd.js => 78.a8184c60.js} | 2 +- assets/js/{80.6fcc683d.js => 80.dffc6861.js} | 2 +- assets/js/{81.5685ade5.js => 81.28f5c3c1.js} | 2 +- assets/js/82.14b4694f.js | 1 - assets/js/82.33e64525.js | 1 + assets/js/{84.3e02561e.js => 84.82bb9bfb.js} | 2 +- .../js/{app.c2d4e2bf.js => app.bc94ff67.js} | 4 +- guide/advanced-usage.html | 6 +- guide/arrays.html | 4 +- guide/basic-operations.html | 6 +- guide/basic-usage.html | 6 +- guide/batch-operations.html | 6 +- guide/branding.html | 4 +- guide/building.html | 4 +- guide/built-in-functions.html | 4 +- guide/cell-references.html | 4 +- guide/client-side-installation.html | 4 +- guide/clipboard-operations.html | 6 +- guide/code-of-conduct.html | 4 +- guide/compatibility-with-google-sheets.html | 4 +- guide/compatibility-with-microsoft-excel.html | 4 +- guide/configuration-options.html | 4 +- guide/contact.html | 4 +- guide/contributing.html | 4 +- guide/custom-functions.html | 6 +- guide/date-and-time-handling.html | 6 +- guide/demo.html | 6 +- guide/dependencies.html | 4 +- guide/dependency-graph.html | 4 +- guide/file-import.html | 4 +- guide/i18n-features.html | 6 +- guide/integration-with-angular.html | 6 +- guide/integration-with-react.html | 6 +- guide/integration-with-svelte.html | 6 +- guide/integration-with-vue.html | 6 +- guide/key-concepts.html | 4 +- guide/known-limitations.html | 4 +- guide/license-key.html | 4 +- guide/licensing.html | 4 +- guide/list-of-differences.html | 4 +- guide/localizing-functions.html | 6 +- guide/migration-from-0.6-to-1.0.html | 4 +- guide/migration-from-1.0-to-2.0.html | 4 +- guide/named-expressions.html | 6 +- guide/order-of-precendece.html | 4 +- guide/performance.html | 4 +- guide/release-notes.html | 4 +- guide/server-side-installation.html | 4 +- guide/sorting-data.html | 6 +- guide/specifications-and-limits.html | 4 +- guide/support.html | 4 +- guide/supported-browsers.html | 4 +- guide/types-of-errors.html | 4 +- guide/types-of-operators.html | 4 +- guide/types-of-values.html | 4 +- guide/undo-redo.html | 6 +- guide/volatile-functions.html | 4 +- index.html | 4 +- 119 files changed, 342 insertions(+), 342 deletions(-) rename assets/js/{20.028dc2b5.js => 20.d1175753.js} (99%) rename assets/js/{25.9bed9b62.js => 25.f6eb2894.js} (99%) rename assets/js/{27.11b6a3ff.js => 27.1eb07f4b.js} (95%) rename assets/js/{28.9a5300e8.js => 28.a6b42c2e.js} (98%) rename assets/js/{29.d2c15be1.js => 29.bff45b76.js} (86%) rename assets/js/{30.845910cf.js => 30.70774167.js} (94%) rename assets/js/{31.edb78418.js => 31.4842ae45.js} (93%) rename assets/js/{32.51d25065.js => 32.3fb72d16.js} (98%) rename assets/js/{33.0b18acdc.js => 33.d6c827f6.js} (90%) rename assets/js/{34.61ab12b3.js => 34.e78b98bf.js} (96%) rename assets/js/{36.56a7ae41.js => 36.d2174e4f.js} (98%) rename assets/js/{37.d14d492b.js => 37.a71973b7.js} (91%) rename assets/js/{38.8f703866.js => 38.464afe70.js} (97%) rename assets/js/{39.71a01a28.js => 39.b3f3fab4.js} (97%) rename assets/js/{40.2c098a09.js => 40.c7c31d0b.js} (99%) rename assets/js/{41.42833c07.js => 41.e875b384.js} (99%) rename assets/js/{42.758cc26b.js => 42.2f924bff.js} (99%) rename assets/js/{43.446790b6.js => 43.18b61786.js} (99%) rename assets/js/{44.24f60e46.js => 44.9d686178.js} (96%) rename assets/js/{46.cdb9500c.js => 46.f2c1cd66.js} (99%) rename assets/js/{47.e4b3f370.js => 47.bb2946d5.js} (99%) rename assets/js/{48.c15683f6.js => 48.0b99222a.js} (98%) rename assets/js/{49.75c2b850.js => 49.4f1be892.js} (97%) rename assets/js/{50.43832462.js => 50.a373e841.js} (98%) rename assets/js/{51.1f0d82cb.js => 51.c86ed915.js} (73%) rename assets/js/{52.0cd5f737.js => 52.71b4d388.js} (95%) delete mode 100644 assets/js/53.3642c010.js create mode 100644 assets/js/53.fff0fdfc.js rename assets/js/{54.ecf0ef7e.js => 54.0f1b03cf.js} (97%) rename assets/js/{55.63d94e73.js => 55.33186257.js} (99%) rename assets/js/{56.a2f69074.js => 56.073b63a2.js} (99%) rename assets/js/{57.22feb479.js => 57.d68070b8.js} (95%) rename assets/js/{58.b780ec13.js => 58.b81b9346.js} (94%) rename assets/js/{59.0483cbf7.js => 59.87cbf7b7.js} (51%) rename assets/js/{60.8e4e20a3.js => 60.f0b88f75.js} (53%) rename assets/js/{61.aa4e40a9.js => 61.82c62269.js} (64%) rename assets/js/{62.92b9a768.js => 62.77b1d9e4.js} (99%) rename assets/js/{63.8a709a4f.js => 63.2af032cd.js} (98%) rename assets/js/{65.e88e2c97.js => 65.4c8d33c5.js} (98%) rename assets/js/{66.b36e89fd.js => 66.715c0b5c.js} (99%) rename assets/js/{67.9a07a251.js => 67.cb024ca8.js} (94%) rename assets/js/{68.3696c8f4.js => 68.e69c4b73.js} (99%) rename assets/js/{69.36e8fc1b.js => 69.9f71d49c.js} (98%) rename assets/js/{70.5365e0f7.js => 70.db7c195e.js} (95%) rename assets/js/{71.1849dde1.js => 71.09e74e94.js} (98%) rename assets/js/{72.5ff76d95.js => 72.7f186870.js} (98%) rename assets/js/{73.c200c01d.js => 73.eb2226cd.js} (99%) rename assets/js/{74.c1180d57.js => 74.17f5f9a5.js} (98%) rename assets/js/{75.9c101195.js => 75.06b4898a.js} (97%) rename assets/js/{76.951726a1.js => 76.2c0816b0.js} (99%) rename assets/js/{77.33977693.js => 77.366a49ba.js} (97%) rename assets/js/{78.741e3ffd.js => 78.a8184c60.js} (97%) rename assets/js/{80.6fcc683d.js => 80.dffc6861.js} (99%) rename assets/js/{81.5685ade5.js => 81.28f5c3c1.js} (99%) delete mode 100644 assets/js/82.14b4694f.js create mode 100644 assets/js/82.33e64525.js rename assets/js/{84.3e02561e.js => 84.82bb9bfb.js} (99%) rename assets/js/{app.c2d4e2bf.js => app.bc94ff67.js} (74%) diff --git a/404.html b/404.html index a3f1c8f7f..3ad0628b4 100644 --- a/404.html +++ b/404.html @@ -35,7 +35,7 @@ - + @@ -45,6 +45,6 @@

404

How did we get here?
Take me home.
- + \ No newline at end of file diff --git a/api-ref-readme.html b/api-ref-readme.html index eaa77a4b9..ab9b2418f 100644 --- a/api-ref-readme.html +++ b/api-ref-readme.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

Welcome to the HyperFormula v2.7.0 API!

The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.

Current build: 10/04/2024 13:38:59

# API reference index

The following sections explain shortly what can be found in the left sidebar navigation menu.

# HyperFormula

This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.

The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:

const sheetData = [
+     (opens new window)    
 
Welcome to the HyperFormula v2.7.0 API!
 
The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.
 
Current build: 20/06/2024 10:19:30
 
# API reference index
 
The following sections explain shortly what can be found in the left sidebar navigation menu.
 
# HyperFormula
 
This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.
 
The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:
 
const sheetData = [
   ['0', '=SUM(1, 2, 3)', '52'],
   ['=SUM(A1:C1)', '', '=A1'],
   ['2', '=SUM(A1:C1)', '91'],
@@ -77,6 +77,6 @@
 
 const nameProvided = hfInstance.addSheet('MySheet3');
- + \ No newline at end of file diff --git a/api/classes/emitter.html b/api/classes/emitter.html index a7d238c21..756b08230 100644 --- a/api/classes/emitter.html +++ b/api/classes/emitter.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Emitter Class

# Methods

# emit

▸ emit‹Event›(event: Event, ...args: Parameters‹Listeners[Event]›): this

Defined in src/Emitter.ts:328 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
event Event
...args Parameters‹Listeners[Event]›

Returns: this

# off

▸ off(event: string, callback?: Function): this

Parameters:

Name Type
event string
callback? Function

Returns: this

# on

▸ on(event: string, callback: Function, ctx?: any): this

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

# once

▸ once(event: string, callback: Function, ctx?: any): this

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

- + (opens new window)

# Emitter Class

# Methods

# emit

▸ emit‹Event›(event: Event, ...args: Parameters‹Listeners[Event]›): this

Defined in src/Emitter.ts:328 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
event Event
...args Parameters‹Listeners[Event]›

Returns: this

# off

▸ off(event: string, callback?: Function): this

Parameters:

Name Type
event string
callback? Function

Returns: this

# on

▸ on(event: string, callback: Function, ctx?: any): this

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

# once

▸ once(event: string, callback: Function, ctx?: any): this

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

+ \ No newline at end of file diff --git a/api/classes/hyperformula.html b/api/classes/hyperformula.html index d27eec0b9..4e1ab97f6 100644 --- a/api/classes/hyperformula.html +++ b/api/classes/hyperformula.html @@ -35,7 +35,7 @@ - + @@ -62,13 +62,13 @@ which can be manipulated as well. The smallest possible data unit are the cells, which may contain simple values or formulas to be calculated.

All CRUD methods are called directly on HyperFormula instance and will trigger corresponding lifecycle events. The events are marked accordingly, as well as thrown -errors, so they can be correctly handled.

# Static Properties

# buildDate Static

▪ buildDate: string = '10/04/2024 13:38:59'

Defined in src/HyperFormula.ts:101 (opens new window)

Latest build date.

# languages Static

▪ languages: Record‹string, RawTranslationPackage›

Defined in src/HyperFormula.ts:117 (opens new window)

When using the UMD build, this property contains all available languages to use with the registerLanguage method.

For more information, see the Localizing functions guide.

# releaseDate Static

▪ releaseDate: string = '10/04/2024'

Defined in src/HyperFormula.ts:108 (opens new window)

A release date.

# version Static

▪ version: string = '2.7.0'

Defined in src/HyperFormula.ts:94 (opens new window)

Version of the HyperFormula.

# Static Accessors

# defaultConfig Static

• get defaultConfig(): ConfigParams

Defined in src/HyperFormula.ts:156 (opens new window)

Returns all of HyperFormula's default configuration options.

example

// returns all default configuration options
+errors, so they can be correctly handled.
 
# Static Properties
 
# buildDate Static
 
▪ buildDate: string = '20/06/2024 10:19:30'
 
Defined in src/HyperFormula.ts:101 (opens new window)
 
Latest build date.
 
 
# languages Static
 
▪ languages: Record‹string, RawTranslationPackage›
 
Defined in src/HyperFormula.ts:117 (opens new window)
 
When using the UMD build, this property contains all available languages to use with the registerLanguage method.
 
For more information, see the Localizing functions guide.
 
 
# releaseDate Static
 
▪ releaseDate: string = '10/04/2024'
 
Defined in src/HyperFormula.ts:108 (opens new window)
 
A release date.
 
 
# version Static
 
▪ version: string = '2.7.0'
 
Defined in src/HyperFormula.ts:94 (opens new window)
 
Version of the HyperFormula.
 
# Static Accessors
 
# defaultConfig Static
 
• get defaultConfig(): ConfigParams
 
Defined in src/HyperFormula.ts:156 (opens new window)
 
Returns all of HyperFormula's default configuration options.
 
example
 
// returns all default configuration options
 const defaultConfig = HyperFormula.defaultConfig;
-
category Static Accessors
 
Returns: ConfigParams
 
# Factories
 
# buildEmpty Static
 
▸ buildEmpty(configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula
 
Defined in src/HyperFormula.ts:328 (opens new window)
 
Builds an empty engine instance.
+

category Static Accessors

Returns: ConfigParams

# Factories

# buildEmpty Static

▸ buildEmpty(configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula

Defined in src/HyperFormula.ts:328 (opens new window)

Builds an empty engine instance. Can be configured with the optional parameter that represents a ConfigParams. If not specified the engine will be built with the default configuration.

example

// build with no initial data and with optional config parameter maxColumns
 const hfInstance = HyperFormula.buildEmpty({ maxColumns: 1000 });
-

Parameters:

Name Type Default Description
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# buildFromArray Static

▸ buildFromArray(sheet: Sheet, configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula

Defined in src/HyperFormula.ts:268 (opens new window)

Builds the engine for a sheet from a two-dimensional array representation. +

Parameters:

Name Type Default Description
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# buildFromArray Static

▸ buildFromArray(sheet: Sheet, configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula

Defined in src/HyperFormula.ts:268 (opens new window)

Builds the engine for a sheet from a two-dimensional array representation. The engine is created with a single sheet. Can be configured with the optional second parameter that represents a ConfigParams. If not specified, the engine will be built with the default configuration.

throws [[SheetSizeLimitExceededError]] when sheet size exceeds the limits

throws [[InvalidArgumentsError]] when sheet is not an array of arrays

throws [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata

example

// data represented as an array
@@ -80,7 +80,7 @@
 
 // method with optional config parameter maxColumns
 const hfInstance = HyperFormula.buildFromArray(sheetData, { maxColumns: 1000 });
-

Parameters:

Name Type Default Description
sheet Sheet - two-dimensional array representation of sheet
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# buildFromSheets Static

▸ buildFromSheets(sheets: Sheets, configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula

Defined in src/HyperFormula.ts:308 (opens new window)

Builds the engine from an object containing multiple sheets with names. +

Parameters:

Name Type Default Description
sheet Sheet - two-dimensional array representation of sheet
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# buildFromSheets Static

▸ buildFromSheets(sheets: Sheets, configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula

Defined in src/HyperFormula.ts:308 (opens new window)

Builds the engine from an object containing multiple sheets with names. The engine is created with one or more sheets. Can be configured with the optional second parameter that represents a ConfigParams. If not specified the engine will be built with the default configuration.

throws [[SheetSizeLimitExceededError]] when sheet size exceeds the limits

throws [[InvalidArgumentsError]] when any sheet is not an array of arrays

throws [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata

example

// data represented as an object with sheets: Sheet1 and Sheet2
@@ -99,19 +99,19 @@
 
 // method with optional config parameter useColumnIndex
 const hfInstance = HyperFormula.buildFromSheets(sheetData, { useColumnIndex: true });
-

Parameters:

Name Type Default Description
sheets Sheets - object with sheets definition
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# Instance

# destroy

▸ destroy(): void

Defined in src/HyperFormula.ts:4402 (opens new window)

Destroys instance of HyperFormula.

example

// destroys the instance
+

Parameters:

Name Type Default Description
sheets Sheets - object with sheets definition
configInput Partial‹ConfigParams› {} engine configuration
namedExpressions SerializedNamedExpression[] [] starting named expressions

Returns: HyperFormula

# Instance

# destroy

▸ destroy(): void

Defined in src/HyperFormula.ts:4402 (opens new window)

Destroys instance of HyperFormula.

example

// destroys the instance
 hfInstance.destroy();
-

Returns: void

# getConfig

▸ getConfig(): ConfigParams

Defined in src/HyperFormula.ts:1019 (opens new window)

Returns current configuration of the engine instance.

example

// should return all config metadata including default and those which were added
+

Returns: void

# getConfig

▸ getConfig(): ConfigParams

Defined in src/HyperFormula.ts:1019 (opens new window)

Returns current configuration of the engine instance.

example

// should return all config metadata including default and those which were added
 const hfConfig = hfInstance.getConfig();
-

Returns: ConfigParams

# rebuildAndRecalculate

▸ rebuildAndRecalculate(): void

Defined in src/HyperFormula.ts:1033 (opens new window)

Rebuilds the HyperFormula instance preserving the current sheets data.

example

hfInstance.rebuildAndRecalculate();
-

Returns: void

# updateConfig

▸ updateConfig(newParams: Partial‹ConfigParams›): void

Defined in src/HyperFormula.ts:998 (opens new window)

Updates the config with given new metadata. It is an expensive operation, as it might trigger rebuilding the engine and recalculation of all formulas.

throws [[ExpectedValueOfTypeError]] when some parameters of config are of wrong type (e.g., currencySymbol)

throws [[ConfigValueEmpty]] when some parameters of config are of invalid value (e.g., currencySymbol)

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: ConfigParams

# rebuildAndRecalculate

▸ rebuildAndRecalculate(): void

Defined in src/HyperFormula.ts:1033 (opens new window)

Rebuilds the HyperFormula instance preserving the current sheets data.

example

hfInstance.rebuildAndRecalculate();
+

Returns: void

# updateConfig

▸ updateConfig(newParams: Partial‹ConfigParams›): void

Defined in src/HyperFormula.ts:998 (opens new window)

Updates the config with given new metadata. It is an expensive operation, as it might trigger rebuilding the engine and recalculation of all formulas.

throws [[ExpectedValueOfTypeError]] when some parameters of config are of wrong type (e.g., currencySymbol)

throws [[ConfigValueEmpty]] when some parameters of config are of invalid value (e.g., currencySymbol)

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
 ]);
 
 // add a config param, for example maxColumns,
 // you can check the configuration with getConfig method
 hfInstance.updateConfig({ maxColumns: 1000 });
-

Parameters:

Name Type Description
newParams Partial‹ConfigParams› configuration options to be updated or added

Returns: void

# Sheets

# addSheet

▸ addSheet(sheetName?: undefined | string): string

Defined in src/HyperFormula.ts:2571 (opens new window)

Adds a new sheet to the HyperFormula instance. Returns given or autogenerated name of a new sheet.

fires sheetAdded after the sheet was added

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[SheetNameAlreadyTakenError]] when sheet with a given name already exists

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
newParams Partial‹ConfigParams› configuration options to be updated or added

Returns: void

# Sheets

# addSheet

▸ addSheet(sheetName?: undefined | string): string

Defined in src/HyperFormula.ts:2571 (opens new window)

Adds a new sheet to the HyperFormula instance. Returns given or autogenerated name of a new sheet.

fires sheetAdded after the sheet was added

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[SheetNameAlreadyTakenError]] when sheet with a given name already exists

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
 });
@@ -122,7 +122,7 @@
 // should return autogenerated 'Sheet4'
 // because no name was provided and 3 other ones already exist
 const generatedName = hfInstance.addSheet();
-

Parameters:

Name Type
sheetName? undefined | string

Returns: string

# clearSheet

▸ clearSheet(sheetId: number): ExportedChange[]

Defined in src/HyperFormula.ts:2718 (opens new window)

Clears the sheet content. Double-checks if the sheet exists.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type
sheetName? undefined | string

Returns: string

# clearSheet

▸ clearSheet(sheetId: number): ExportedChange[]

Defined in src/HyperFormula.ts:2718 (opens new window)

Clears the sheet content. Double-checks if the sheet exists.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
  MySheet2: [ ['10'] ],
 });
@@ -134,20 +134,20 @@
 //   newValue: 0,
 // }]
 const changes = hfInstance.clearSheet(0);
-

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# countSheets

▸ countSheets(): number

Defined in src/HyperFormula.ts:3360 (opens new window)

Returns the number of existing sheets.

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# countSheets

▸ countSheets(): number

Defined in src/HyperFormula.ts:3360 (opens new window)

Returns the number of existing sheets.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
 ]);
 
 // should return the number of sheets which is '1'
 const sheetsCount = hfInstance.countSheets();
-

Returns: number

# doesSheetExist

▸ doesSheetExist(sheetName: string): boolean

Defined in src/HyperFormula.ts:3083 (opens new window)

Returns true whether sheet with a given name exists. The method accepts sheet name to be checked.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
+

Returns: number

# doesSheetExist

▸ doesSheetExist(sheetName: string): boolean

Defined in src/HyperFormula.ts:3083 (opens new window)

Returns true whether sheet with a given name exists. The method accepts sheet name to be checked.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ],
 });
 
 // should return 'true' since 'MySheet1' exists
 const sheetExist = hfInstance.doesSheetExist('MySheet1');
-

Parameters:

Name Type Description
sheetName string name of the sheet, case-insensitive.

Returns: boolean

# getAllSheetsDimensions

▸ getAllSheetsDimensions(): Record‹string, SheetDimensions›

Defined in src/HyperFormula.ts:882 (opens new window)

Returns a map containing dimensions of all sheets for the engine instance represented as a key-value pairs where keys are sheet IDs and dimensions are returned as numbers, width and height respectively.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetName string name of the sheet, case-insensitive.

Returns: boolean

# getAllSheetsDimensions

▸ getAllSheetsDimensions(): Record‹string, SheetDimensions›

Defined in src/HyperFormula.ts:882 (opens new window)

Returns a map containing dimensions of all sheets for the engine instance represented as a key-value pairs where keys are sheet IDs and dimensions are returned as numbers, width and height respectively.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
   Sheet1: [
    ['1', '2', '=Sheet2!$A1'],
   ],
@@ -160,32 +160,32 @@
 // should return the dimensions of all sheets:
 // { Sheet1: { width: 3, height: 1 }, Sheet2: { width: 1, height: 2 } }
 const allSheetsDimensions = hfInstance.getAllSheetsDimensions();
-

Returns: Record‹string, SheetDimensions›

# getAllSheetsFormulas

▸ getAllSheetsFormulas(): Record‹string, (string | undefined)[][]›

Defined in src/HyperFormula.ts:951 (opens new window)

Returns formulas of all sheets in a form of an object which property keys are strings and values are 2D arrays of strings or possibly undefined when the call does not contain a formula.

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: Record‹string, SheetDimensions›

# getAllSheetsFormulas

▸ getAllSheetsFormulas(): Record‹string, (string | undefined)[][]›

Defined in src/HyperFormula.ts:951 (opens new window)

Returns formulas of all sheets in a form of an object which property keys are strings and values are 2D arrays of strings or possibly undefined when the call does not contain a formula.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2', '=A1+10'],
 ]);
 
 // should return only formulas: { Sheet1: [ [ undefined, undefined, '=A1+10' ] ] }
 const allSheetsFormulas = hfInstance.getAllSheetsFormulas();
-

Returns: Record‹string, (string | undefined)[][]›

# getAllSheetsSerialized

▸ getAllSheetsSerialized(): Record‹string, RawCellContent[][]›

Defined in src/HyperFormula.ts:972 (opens new window)

Returns formulas or values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[RawCellContent]].

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: Record‹string, (string | undefined)[][]›

# getAllSheetsSerialized

▸ getAllSheetsSerialized(): Record‹string, RawCellContent[][]›

Defined in src/HyperFormula.ts:972 (opens new window)

Returns formulas or values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[RawCellContent]].

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2', '=A1+10'],
 ]);
 
 // should return all sheets serialized content: { Sheet1: [ [ 1, 2, '=A1+10' ] ] }
 const allSheetsSerialized = hfInstance.getAllSheetsSerialized();
-

Returns: Record‹string, RawCellContent[][]›

# getAllSheetsValues

▸ getAllSheetsValues(): Record‹string, CellValue[][]›

Defined in src/HyperFormula.ts:932 (opens new window)

Returns values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[CellValue]].

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: Record‹string, RawCellContent[][]›

# getAllSheetsValues

▸ getAllSheetsValues(): Record‹string, CellValue[][]›

Defined in src/HyperFormula.ts:932 (opens new window)

Returns values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[CellValue]].

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '=A1+10', '3'],
 ]);
 
 // should return all sheets values: { Sheet1: [ [ 1, 11, 3 ] ] }
 const allSheetsValues = hfInstance.getAllSheetsValues();
-

Returns: Record‹string, CellValue[][]›

# getSheetDimensions

▸ getSheetDimensions(sheetId: number): SheetDimensions

Defined in src/HyperFormula.ts:907 (opens new window)

Returns dimensions of a specified sheet. +

Returns: Record‹string, CellValue[][]›

# getSheetDimensions

▸ getSheetDimensions(sheetId: number): SheetDimensions

Defined in src/HyperFormula.ts:907 (opens new window)

Returns dimensions of a specified sheet. The sheet dimensions is represented with numbers: width and height.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
    ['1', '2', '=Sheet2!$A1'],
 ]);
 
 // should return provided sheet's dimensions: { width: 3, height: 1 }
 const sheetDimensions = hfInstance.getSheetDimensions(0);
-

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: SheetDimensions

# getSheetFormulas

▸ getSheetFormulas(sheetId: number): (string | undefined)[][]

Defined in src/HyperFormula.ts:819 (opens new window)

Returns an array with normalized formula strings from [[Sheet]] or undefined for a cells that have no value.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: SheetDimensions

# getSheetFormulas

▸ getSheetFormulas(sheetId: number): (string | undefined)[][]

Defined in src/HyperFormula.ts:819 (opens new window)

Returns an array with normalized formula strings from [[Sheet]] or undefined for a cells that have no value.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['0', '=SUM(1, 2, 3)', '=A1'],
  ['1', '=TEXT(A2, "0.0%")', '=C1'],
  ['2', '=SUM(A1:C1)', '=C1'],
@@ -198,21 +198,21 @@
 //  [undefined, '=SUM(A1:C1)', '=C1'],
 // ];
 const sheetFormulas = hfInstance.getSheetFormulas(0);
-

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: (string | undefined)[][]

# getSheetId

▸ getSheetId(sheetName: string): number | undefined

Defined in src/HyperFormula.ts:3058 (opens new window)

Returns a unique sheet ID assigned to the sheet with a given name or undefined if the sheet does not exist.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: (string | undefined)[][]

# getSheetId

▸ getSheetId(sheetName: string): number | undefined

Defined in src/HyperFormula.ts:3058 (opens new window)

Returns a unique sheet ID assigned to the sheet with a given name or undefined if the sheet does not exist.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ],
 });
 
 // should return '0' because 'MySheet1' is of ID '0'
 const sheetID = hfInstance.getSheetId('MySheet1');
-

Parameters:

Name Type Description
sheetName string name of the sheet, for which we want to retrieve ID, case-insensitive.

Returns: number | undefined

# getSheetName

▸ getSheetName(sheetId: number): string | undefined

Defined in src/HyperFormula.ts:3012 (opens new window)

Returns a unique sheet name assigned to the sheet of a given ID or undefined if the there is no sheet with a given ID.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetName string name of the sheet, for which we want to retrieve ID, case-insensitive.

Returns: number | undefined

# getSheetName

▸ getSheetName(sheetId: number): string | undefined

Defined in src/HyperFormula.ts:3012 (opens new window)

Returns a unique sheet name assigned to the sheet of a given ID or undefined if the there is no sheet with a given ID.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
 });
 
 // should return 'MySheet2' as this sheet is the second one
 const sheetName = hfInstance.getSheetName(1);
-

Parameters:

Name Type Description
sheetId number ID of the sheet, for which we want to retrieve name

Returns: string | undefined

# getSheetNames

▸ getSheetNames(): string[]

Defined in src/HyperFormula.ts:3034 (opens new window)

List all sheet names. +

Parameters:

Name Type Description
sheetId number ID of the sheet, for which we want to retrieve name

Returns: string | undefined

# getSheetNames

▸ getSheetNames(): string[]

Defined in src/HyperFormula.ts:3034 (opens new window)

List all sheet names. Returns an array of sheet names as strings.

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
@@ -220,7 +220,7 @@
 
 // should return all sheets names: ['MySheet1', 'MySheet2']
 const sheetNames = hfInstance.getSheetNames();
-

Returns: string[]

# getSheetSerialized

▸ getSheetSerialized(sheetId: number): RawCellContent[][]

Defined in src/HyperFormula.ts:852 (opens new window)

Returns an array of arrays of [[RawCellContent]] with serialized content of cells from [[Sheet]], either a cell formula or an explicit value.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: string[]

# getSheetSerialized

▸ getSheetSerialized(sheetId: number): RawCellContent[][]

Defined in src/HyperFormula.ts:852 (opens new window)

Returns an array of arrays of [[RawCellContent]] with serialized content of cells from [[Sheet]], either a cell formula or an explicit value.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['0', '=SUM(1, 2, 3)', '=A1'],
  ['1', '=TEXT(A2, "0.0%")', '=C1'],
  ['2', '=SUM(A1:C1)', '=C1'],
@@ -233,7 +233,7 @@
 //  ['2', '=SUM(A1:C1)', '=C1'],
 // ];
 const serializedContent = hfInstance.getSheetSerialized(0);
-

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: RawCellContent[][]

# getSheetValues

▸ getSheetValues(sheetId: number): CellValue[][]

Defined in src/HyperFormula.ts:786 (opens new window)

Returns an array of arrays of [[CellValue]] with values of all cells from [[Sheet]]. +

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: RawCellContent[][]

# getSheetValues

▸ getSheetValues(sheetId: number): CellValue[][]

Defined in src/HyperFormula.ts:786 (opens new window)

Returns an array of arrays of [[CellValue]] with values of all cells from [[Sheet]]. Applies rounding and post-processing.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
  ['0', '=SUM(1, 2, 3)', '=A1'],
  ['1', '=TEXT(A2, "0.0%")', '=C1'],
@@ -242,7 +242,7 @@
 
 // should return all values of a sheet: [[0, 6, 0], [1, '1.0%', 0], [2, 6, 0]]
 const sheetValues = hfInstance.getSheetValues(0);
-

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: CellValue[][]

# isItPossibleToAddSheet

▸ isItPossibleToAddSheet(sheetName: string): boolean

Defined in src/HyperFormula.ts:2534 (opens new window)

Returns information whether it is possible to add a sheet to the engine. +

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: CellValue[][]

# isItPossibleToAddSheet

▸ isItPossibleToAddSheet(sheetName: string): boolean

Defined in src/HyperFormula.ts:2534 (opens new window)

Returns information whether it is possible to add a sheet to the engine. Checks against particular rules to ascertain that addSheet can be called. If returns true, doing addSheet operation won't throw any errors, and it is possible to add sheet with provided name. Returns false if the chosen name is already used.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
@@ -252,7 +252,7 @@
 
 // should return 'false' because 'MySheet2' already exists
 const isAddable = hfInstance.isItPossibleToAddSheet('MySheet2');
-

Parameters:

Name Type Description
sheetName string sheet name, case-insensitive

Returns: boolean

# isItPossibleToClearSheet

▸ isItPossibleToClearSheet(sheetId: number): boolean

Defined in src/HyperFormula.ts:2676 (opens new window)

Returns information whether it is possible to clear a specified sheet. +

Parameters:

Name Type Description
sheetName string sheet name, case-insensitive

Returns: boolean

# isItPossibleToClearSheet

▸ isItPossibleToClearSheet(sheetId: number): boolean

Defined in src/HyperFormula.ts:2676 (opens new window)

Returns information whether it is possible to clear a specified sheet. If returns true, doing clearSheet operation won't throw any errors, provided sheet exists and its content can be cleared. Returns false otherwise

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
@@ -261,7 +261,7 @@
 
 // should return 'true' because 'MySheet2' exists and can be cleared
 const isClearable = hfInstance.isItPossibleToClearSheet(1);
-

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRemoveSheet

▸ isItPossibleToRemoveSheet(sheetId: number): boolean

Defined in src/HyperFormula.ts:2602 (opens new window)

Returns information whether it is possible to remove sheet for the engine. +

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRemoveSheet

▸ isItPossibleToRemoveSheet(sheetId: number): boolean

Defined in src/HyperFormula.ts:2602 (opens new window)

Returns information whether it is possible to remove sheet for the engine. Returns true if the provided sheet exists, and therefore it can be removed, doing removeSheet operation won't throw any errors. Returns false otherwise

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
@@ -270,7 +270,7 @@
 
 // should return 'true' because sheet with ID 1 exists and is removable
 const isRemovable = hfInstance.isItPossibleToRemoveSheet(1);
-

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRenameSheet

▸ isItPossibleToRenameSheet(sheetId: number, newName: string): boolean

Defined in src/HyperFormula.ts:3387 (opens new window)

Returns information whether it is possible to rename sheet. +

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRenameSheet

▸ isItPossibleToRenameSheet(sheetId: number, newName: string): boolean

Defined in src/HyperFormula.ts:3387 (opens new window)

Returns information whether it is possible to rename sheet. Returns true if the sheet with provided id exists and new name is available Returns false if sheet cannot be renamed

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
@@ -279,7 +279,7 @@
 
 // returns true
 hfInstance.isItPossibleToRenameSheet(0, 'MySheet0');
-

Parameters:

Name Type Description
sheetId number a sheet number
newName string a name of the sheet to be given

Returns: boolean

# isItPossibleToReplaceSheetContent

▸ isItPossibleToReplaceSheetContent(sheetId: number, values: RawCellContent[][]): boolean

Defined in src/HyperFormula.ts:2748 (opens new window)

Returns information whether it is possible to replace the sheet content. +

Parameters:

Name Type Description
sheetId number a sheet number
newName string a name of the sheet to be given

Returns: boolean

# isItPossibleToReplaceSheetContent

▸ isItPossibleToReplaceSheetContent(sheetId: number, values: RawCellContent[][]): boolean

Defined in src/HyperFormula.ts:2748 (opens new window)

Returns information whether it is possible to replace the sheet content. If returns true, doing setSheetContent operation won't throw any errors, the provided sheet exists and then its content can be replaced. Returns false otherwise

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
@@ -289,7 +289,7 @@
 // should return 'true' because sheet of ID 0 exists
 // and the provided content can be placed in this sheet
 const isReplaceable = hfInstance.isItPossibleToReplaceSheetContent(0, [['50'], ['60']]);
-

Parameters:

Name Type Description
sheetId number sheet ID.
values RawCellContent[][] array of new values

Returns: boolean

# removeSheet

▸ removeSheet(sheetId: number): ExportedChange[]

Defined in src/HyperFormula.ts:2645 (opens new window)

Removes a sheet

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires sheetRemoved after the sheet was removed

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number sheet ID.
values RawCellContent[][] array of new values

Returns: boolean

# removeSheet

▸ removeSheet(sheetId: number): ExportedChange[]

Defined in src/HyperFormula.ts:2645 (opens new window)

Removes a sheet

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires sheetRemoved after the sheet was removed

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
  MySheet2: [ ['10'] ],
 });
@@ -301,14 +301,14 @@
 //   newValue: { error: [CellError], value: '#REF!' },
 // }]
 const changes = hfInstance.removeSheet(1);
-

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# renameSheet

▸ renameSheet(sheetId: number, newName: string): void

Defined in src/HyperFormula.ts:3423 (opens new window)

Renames a specified sheet.

fires sheetRenamed after the sheet was renamed

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[SheetNameAlreadyTakenError]] when the provided sheet name already exists

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# renameSheet

▸ renameSheet(sheetId: number, newName: string): void

Defined in src/HyperFormula.ts:3423 (opens new window)

Renames a specified sheet.

fires sheetRenamed after the sheet was renamed

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[SheetNameAlreadyTakenError]] when the provided sheet name already exists

example

const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ],
 });
 
 // renames the sheet 'MySheet1'
 hfInstance.renameSheet(0, 'MySheet0');
-

Parameters:

Name Type Description
sheetId number a sheet ID
newName string a name of the sheet to be given, if is the same as the old one the method does nothing

Returns: void

# setSheetContent

▸ setSheetContent(sheetId: number, values: RawCellContent[][]): ExportedChange[]

Defined in src/HyperFormula.ts:2785 (opens new window)

Replaces the sheet content with new values.

Returns an array of cells whose values changed as a result of this operation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when values argument is not an array of arrays

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number a sheet ID
newName string a name of the sheet to be given, if is the same as the old one the method does nothing

Returns: void

# setSheetContent

▸ setSheetContent(sheetId: number, values: RawCellContent[][]): ExportedChange[]

Defined in src/HyperFormula.ts:2785 (opens new window)

Replaces the sheet content with new values.

Returns an array of cells whose values changed as a result of this operation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when values argument is not an array of arrays

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
 });
@@ -316,12 +316,12 @@
 // should return a list of cells which values changed after the operation,
 // their absolute addresses and new values
 const changes = hfInstance.setSheetContent(0, [['50'], ['60']]);
-

Parameters:

Name Type Description
sheetId number sheet ID.
values RawCellContent[][] array of new values

Returns: ExportedChange[]

# Ranges

# getFillRangeData

▸ getFillRangeData(source: SimpleCellRange, target: SimpleCellRange, offsetsFromTarget: boolean): RawCellContent[][]

Defined in src/HyperFormula.ts:2490 (opens new window)

Returns values to fill target range using source range, with properly extending the range using wrap-around heuristic.

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] if source or target are of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([[1, '=A1'], ['=$A$1', '2']]);
+

Parameters:

Name Type Description
sheetId number sheet ID.
values RawCellContent[][] array of new values

Returns: ExportedChange[]

# Ranges

# getFillRangeData

▸ getFillRangeData(source: SimpleCellRange, target: SimpleCellRange, offsetsFromTarget: boolean): RawCellContent[][]

Defined in src/HyperFormula.ts:2490 (opens new window)

Returns values to fill target range using source range, with properly extending the range using wrap-around heuristic.

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] if source or target are of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([[1, '=A1'], ['=$A$1', '2']]);
 
 // should return [['2', '=$A$1', '2'], ['=A3', 1, '=C3'], ['2', '=$A$1', '2']]
 hfInstance.getFillRangeData( {start: {sheet: 0, row: 0, col: 0}, end: {sheet: 0, row: 1, col: 1}},
 {start: {sheet: 0, row: 1, col: 1}, end: {sheet: 0, row: 3, col: 3}});
-

Parameters:

Name Type Default Description
source SimpleCellRange - of data
target SimpleCellRange - range where data is intended to be put
offsetsFromTarget boolean false if true, offsets are computed from target corner, otherwise from source corner

Returns: RawCellContent[][]

# getRangeFormulas

▸ getRangeFormulas(source: SimpleCellRange): (string | undefined)[][]

Defined in src/HyperFormula.ts:2420 (opens new window)

Returns cell formulas in given range.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Default Description
source SimpleCellRange - of data
target SimpleCellRange - range where data is intended to be put
offsetsFromTarget boolean false if true, offsets are computed from target corner, otherwise from source corner

Returns: RawCellContent[][]

# getRangeFormulas

▸ getRangeFormulas(source: SimpleCellRange): (string | undefined)[][]

Defined in src/HyperFormula.ts:2420 (opens new window)

Returns cell formulas in given range.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2)', '2', '10'],
  ['5', '6', '7'],
  ['40', '30', '20'],
@@ -330,7 +330,7 @@
 // returns cell formulas of a given range only:
 // [ [ '=SUM(1, 2)', undefined ], [ undefined, undefined ] ]
 const rangeFormulas = hfInstance.getRangeFormulas({ start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 1 } });
-

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: (string | undefined)[][]

# getRangeSerialized

▸ getRangeSerialized(source: SimpleCellRange): RawCellContent[][]

Defined in src/HyperFormula.ts:2456 (opens new window)

Returns serialized cells in given range.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: (string | undefined)[][]

# getRangeSerialized

▸ getRangeSerialized(source: SimpleCellRange): RawCellContent[][]

Defined in src/HyperFormula.ts:2456 (opens new window)

Returns serialized cells in given range.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2)', '2', '10'],
  ['5', '6', '7'],
  ['40', '30', '20'],
@@ -339,7 +339,7 @@
 // should return serialized cell content for the given range:
 // [ [ '=SUM(1, 2)', 2 ], [ 5, 6 ] ]
 const rangeSerialized = hfInstance.getRangeSerialized({ start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 1 } });
-

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: RawCellContent[][]

# getRangeValues

▸ getRangeValues(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2384 (opens new window)

Returns the cell content of a given range in a [[CellValue]][][] format.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: RawCellContent[][]

# getRangeValues

▸ getRangeValues(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2384 (opens new window)

Returns the cell content of a given range in a [[CellValue]][][] format.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2)', '2', '10'],
  ['5', '6', '7'],
  ['40', '30', '20'],
@@ -347,7 +347,7 @@
 
 // returns calculated cells content: [ [ 3, 2 ], [ 5, 6 ] ]
 const rangeValues = hfInstance.getRangeValues({ start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 1 } });
-

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: CellValue[][]

# Rows

# addRows

▸ addRows(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1641 (opens new window)

Adds multiple rows into a specified position in a given sheet. +

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: CellValue[][]

# Rows

# addRows

▸ addRows(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1641 (opens new window)

Adds multiple rows into a specified position in a given sheet. Does nothing if rows are outside effective sheet size.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
@@ -356,7 +356,7 @@
 // should return a list of cells which values changed after the operation,
 // their absolute addresses and new values
 const changes = hfInstance.addRows(0, [0, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID in which rows will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added

Returns: ExportedChange[]

# isItPossibleToAddRows

▸ isItPossibleToAddRows(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1599 (opens new window)

Returns information whether it is possible to add rows into a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number sheet ID in which rows will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added

Returns: ExportedChange[]

# isItPossibleToAddRows

▸ isItPossibleToAddRows(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1599 (opens new window)

Returns information whether it is possible to add rows into a specified position in a given sheet. Checks against particular rules to ascertain that addRows can be called. If returns true, doing addRows operation won't throw any errors. Returns false if adding rows would exceed the sheet size limit or given arguments are invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -366,7 +366,7 @@
 // should return 'true' for this example,
 // it is possible to add one row in the second row of sheet 0
 const isAddable = hfInstance.isItPossibleToAddRows(0, [1, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID in which rows will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added

Returns: boolean

# isItPossibleToMoveRows

▸ isItPossibleToMoveRows(sheetId: number, startRow: number, numberOfRows: number, targetRow: number): boolean

Defined in src/HyperFormula.ts:1996 (opens new window)

Returns information whether it is possible to move a particular number of rows to a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number sheet ID in which rows will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added

Returns: boolean

# isItPossibleToMoveRows

▸ isItPossibleToMoveRows(sheetId: number, startRow: number, numberOfRows: number, targetRow: number): boolean

Defined in src/HyperFormula.ts:1996 (opens new window)

Returns information whether it is possible to move a particular number of rows to a specified position in a given sheet. Checks against particular rules to ascertain that moveRows can be called. If returns true, doing moveRows operation won't throw any errors. Returns false if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected rows, the target location includes an array or the provided address is invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -377,7 +377,7 @@
 // should return 'true' for this example
 // it is possible to move one row from row 0 into row 2
 const isMovable = hfInstance.isItPossibleToMoveRows(0, 0, 1, 2);
-

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startRow number number of the first row to move
numberOfRows number number of rows to move
targetRow number row number before which rows will be moved

Returns: boolean

# isItPossibleToRemoveRows

▸ isItPossibleToRemoveRows(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1672 (opens new window)

Returns information whether it is possible to remove rows from a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startRow number number of the first row to move
numberOfRows number number of rows to move
targetRow number row number before which rows will be moved

Returns: boolean

# isItPossibleToRemoveRows

▸ isItPossibleToRemoveRows(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1672 (opens new window)

Returns information whether it is possible to remove rows from a specified position in a given sheet. Checks against particular rules to ascertain that removeRows can be called. If returns true, doing removeRows operation won't throw any errors. Returns false if given arguments are invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -388,7 +388,7 @@
 // should return 'true' for this example
 // it is possible to remove one row from row 1 of sheet 0
 const isRemovable = hfInstance.isItPossibleToRemoveRows(0, [1, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID from which rows will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [row, amount]

Returns: boolean

# isItPossibleToSetRowOrder

▸ isItPossibleToSetRowOrder(sheetId: number, newRowOrder: number[]): boolean

Defined in src/HyperFormula.ts:1402 (opens new window)

Checks if it is possible to reorder rows of a sheet according to a permutation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID from which rows will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [row, amount]

Returns: boolean

# isItPossibleToSetRowOrder

▸ isItPossibleToSetRowOrder(sheetId: number, newRowOrder: number[]): boolean

Defined in src/HyperFormula.ts:1402 (opens new window)

Checks if it is possible to reorder rows of a sheet according to a permutation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  [1],
  [2],
  [4, 5],
@@ -399,7 +399,7 @@
 
 // returns false
 hfInstance.isItPossibleToSetRowOrder(0, [2]);
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newRowOrder number[] permutation of rows

Returns: boolean

# isItPossibleToSwapRowIndexes

▸ isItPossibleToSwapRowIndexes(sheetId: number, rowMapping: [number, number][]): boolean

Defined in src/HyperFormula.ts:1323 (opens new window)

Checks if it is possible to reorder rows of a sheet according to a source-target mapping.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newRowOrder number[] permutation of rows

Returns: boolean

# isItPossibleToSwapRowIndexes

▸ isItPossibleToSwapRowIndexes(sheetId: number, rowMapping: [number, number][]): boolean

Defined in src/HyperFormula.ts:1323 (opens new window)

Checks if it is possible to reorder rows of a sheet according to a source-target mapping.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  [1],
  [2],
  [4, 5],
@@ -410,7 +410,7 @@
 
 // returns false
 const isSwappable = hfInstance.isItPossibleToSwapRowIndexes(0, [[0, 1]]);
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
rowMapping [number, number][] array mapping original positions to final positions of rows

Returns: boolean

# moveRows

▸ moveRows(sheetId: number, startRow: number, numberOfRows: number, targetRow: number): ExportedChange[]

Defined in src/HyperFormula.ts:2043 (opens new window)

Moves a particular number of rows to a specified position in a given sheet.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
rowMapping [number, number][] array mapping original positions to final positions of rows

Returns: boolean

# moveRows

▸ moveRows(sheetId: number, startRow: number, numberOfRows: number, targetRow: number): ExportedChange[]

Defined in src/HyperFormula.ts:2043 (opens new window)

Moves a particular number of rows to a specified position in a given sheet.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
 ]);
@@ -418,7 +418,7 @@
 // should return a list of cells which values changed after the operation,
 // their absolute addresses and new values
 const changes = hfInstance.moveRows(0, 0, 1, 2);
-

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startRow number number of the first row to move
numberOfRows number number of rows to move
targetRow number row number before which rows will be moved

Returns: ExportedChange[]

# removeRows

▸ removeRows(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1713 (opens new window)

Removes multiple rows from a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startRow number number of the first row to move
numberOfRows number number of rows to move
targetRow number row number before which rows will be moved

Returns: ExportedChange[]

# removeRows

▸ removeRows(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1713 (opens new window)

Removes multiple rows from a specified position in a given sheet. Does nothing if rows are outside the effective sheet size.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
@@ -426,7 +426,7 @@
 
 // should return: [{ sheet: 0, col: 1, row: 2, value: null }] for this example
 const changes = hfInstance.removeRows(0, [1, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID from which rows will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [row, amount]

Returns: ExportedChange[]

# setRowOrder

▸ setRowOrder(sheetId: number, newRowOrder: number[]): ExportedChange[]

Defined in src/HyperFormula.ts:1371 (opens new window)

Reorders rows of a sheet according to a permutation of 0-based indexes. +

Parameters:

Name Type Description
sheetId number sheet ID from which rows will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [row, amount]

Returns: ExportedChange[]

# setRowOrder

▸ setRowOrder(sheetId: number, newRowOrder: number[]): ExportedChange[]

Defined in src/HyperFormula.ts:1371 (opens new window)

Reorders rows of a sheet according to a permutation of 0-based indexes. Parameter newRowOrder should have a form [ newPositionForRow0, newPositionForRow1, newPositionForRow2, ... ]. This method might be used to sort the rows of a sheet.

Returns an array of cells whose values changed as a result of this operation.

Note: This method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
  ['A'],
@@ -440,7 +440,7 @@
 const changes = hfInstance.setRowOrder(0, newRowOrder);
 
 // Sheet after this operation: [['A'], ['D'], ['C'], ['B']]
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newRowOrder number[] permutation of rows

Returns: ExportedChange[]

# swapRowIndexes

▸ swapRowIndexes(sheetId: number, rowMapping: [number, number][]): ExportedChange[]

Defined in src/HyperFormula.ts:1292 (opens new window)

Reorders rows of a sheet according to a source-target mapping.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newRowOrder number[] permutation of rows

Returns: ExportedChange[]

# swapRowIndexes

▸ swapRowIndexes(sheetId: number, rowMapping: [number, number][]): ExportedChange[]

Defined in src/HyperFormula.ts:1292 (opens new window)

Reorders rows of a sheet according to a source-target mapping.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
  [1],
  [2],
  [4, 5],
@@ -464,7 +464,7 @@
 //   newValue: 5,
 // }]
 const changes = hfInstance.swapRowIndexes(0, [[0, 2], [2, 0]]);
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
rowMapping [number, number][] array mapping original positions to final positions of rows

Returns: ExportedChange[]

# Columns

# addColumns

▸ addColumns(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1789 (opens new window)

Adds multiple columns into a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
rowMapping [number, number][] array mapping original positions to final positions of rows

Returns: ExportedChange[]

# Columns

# addColumns

▸ addColumns(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1789 (opens new window)

Adds multiple columns into a specified position in a given sheet. Does nothing if the columns are outside the effective sheet size.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

example

const hfInstance = HyperFormula.buildFromArray([
  ['=RAND()', '42'],
 ]);
@@ -476,7 +476,7 @@
 //   newValue: 0.92754862796338,
 // }]
 const changes = hfInstance.addColumns(0, [0, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID in which columns will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added

Returns: ExportedChange[]

# isItPossibleToAddColumns

▸ isItPossibleToAddColumns(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1743 (opens new window)

Returns information whether it is possible to add columns into a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number sheet ID in which columns will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added

Returns: ExportedChange[]

# isItPossibleToAddColumns

▸ isItPossibleToAddColumns(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1743 (opens new window)

Returns information whether it is possible to add columns into a specified position in a given sheet. Checks against particular rules to ascertain that addColumns can be called. If returns true, doing addColumns operation won't throw any errors. Returns false if adding columns would exceed the sheet size limit or given arguments are invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -486,7 +486,7 @@
 // should return 'true' for this example,
 // it is possible to add 1 column in sheet 0, at column 1
 const isAddable = hfInstance.isItPossibleToAddColumns(0, [1, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID in which columns will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added

Returns: boolean

# isItPossibleToMoveColumns

▸ isItPossibleToMoveColumns(sheetId: number, startColumn: number, numberOfColumns: number, targetColumn: number): boolean

Defined in src/HyperFormula.ts:2078 (opens new window)

Returns information whether it is possible to move a particular number of columns to a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number sheet ID in which columns will be added
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added

Returns: boolean

# isItPossibleToMoveColumns

▸ isItPossibleToMoveColumns(sheetId: number, startColumn: number, numberOfColumns: number, targetColumn: number): boolean

Defined in src/HyperFormula.ts:2078 (opens new window)

Returns information whether it is possible to move a particular number of columns to a specified position in a given sheet. Checks against particular rules to ascertain that moveColumns can be called. If returns true, doing moveColumns operation won't throw any errors. Returns false if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -496,7 +496,7 @@
 // should return 'true' for this example
 // it is possible to move one column from column 1 into column 2 of sheet 0
 const isMovable = hfInstance.isItPossibleToMoveColumns(0, 1, 1, 2);
-

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startColumn number number of the first column to move
numberOfColumns number number of columns to move
targetColumn number column number before which columns will be moved

Returns: boolean

# isItPossibleToRemoveColumns

▸ isItPossibleToRemoveColumns(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1819 (opens new window)

Returns information whether it is possible to remove columns from a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startColumn number number of the first column to move
numberOfColumns number number of columns to move
targetColumn number column number before which columns will be moved

Returns: boolean

# isItPossibleToRemoveColumns

▸ isItPossibleToRemoveColumns(sheetId: number, ...indexes: ColumnRowIndex[]): boolean

Defined in src/HyperFormula.ts:1819 (opens new window)

Returns information whether it is possible to remove columns from a specified position in a given sheet. Checks against particular rules to ascertain that removeColumns can be called. If returns true, doing removeColumns operation won't throw any errors. Returns false if given arguments are invalid.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -506,7 +506,7 @@
 // should return 'true' for this example
 // it is possible to remove one column, in place of the second column of sheet 0
 const isRemovable = hfInstance.isItPossibleToRemoveColumns(0, [1, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID from which columns will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format [column, amount]

Returns: boolean

# isItPossibleToSetColumnOrder

▸ isItPossibleToSetColumnOrder(sheetId: number, newColumnOrder: number[]): boolean

Defined in src/HyperFormula.ts:1563 (opens new window)

Checks if it is possible to reorder columns of a sheet according to a permutation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID from which columns will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format [column, amount]

Returns: boolean

# isItPossibleToSetColumnOrder

▸ isItPossibleToSetColumnOrder(sheetId: number, newColumnOrder: number[]): boolean

Defined in src/HyperFormula.ts:1563 (opens new window)

Checks if it is possible to reorder columns of a sheet according to a permutation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  [1, 2, 4],
  [5]
 ]);
@@ -516,7 +516,7 @@
 
 // returns false
 hfInstance.isItPossibleToSetColumnOrder(0, [1]);
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newColumnOrder number[] permutation of columns

Returns: boolean

# isItPossibleToSwapColumnIndexes

▸ isItPossibleToSwapColumnIndexes(sheetId: number, columnMapping: [number, number][]): boolean

Defined in src/HyperFormula.ts:1488 (opens new window)

Checks if it is possible to reorder columns of a sheet according to a source-target mapping.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newColumnOrder number[] permutation of columns

Returns: boolean

# isItPossibleToSwapColumnIndexes

▸ isItPossibleToSwapColumnIndexes(sheetId: number, columnMapping: [number, number][]): boolean

Defined in src/HyperFormula.ts:1488 (opens new window)

Checks if it is possible to reorder columns of a sheet according to a source-target mapping.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  [1, 2, 4],
  [5]
 ]);
@@ -526,7 +526,7 @@
 
 // returns false
 hfInstance.isItPossibleToSwapColumnIndexes(0, [[0, 1]]);
-

Parameters:

Name Type
sheetId number
columnMapping [number, number][]

Returns: boolean

# moveColumns

▸ moveColumns(sheetId: number, startColumn: number, numberOfColumns: number, targetColumn: number): ExportedChange[]

Defined in src/HyperFormula.ts:2131 (opens new window)

Moves a particular number of columns to a specified position in a given sheet.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type
sheetId number
columnMapping [number, number][]

Returns: boolean

# moveColumns

▸ moveColumns(sheetId: number, startColumn: number, numberOfColumns: number, targetColumn: number): ExportedChange[]

Defined in src/HyperFormula.ts:2131 (opens new window)

Moves a particular number of columns to a specified position in a given sheet.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2', '3', '=RAND()', '=SUM(A1:C1)'],
 ]);
 
@@ -540,7 +540,7 @@
 //   newValue: 6.16210054671639,
 // }]
 const changes = hfInstance.moveColumns(0, 1, 1, 2);
-

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startColumn number number of the first column to move
numberOfColumns number number of columns to move
targetColumn number column number before which columns will be moved

Returns: ExportedChange[]

# removeColumns

▸ removeColumns(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1864 (opens new window)

Removes multiple columns from a specified position in a given sheet. +

Parameters:

Name Type Description
sheetId number a sheet number in which the operation will be performed
startColumn number number of the first column to move
numberOfColumns number number of columns to move
targetColumn number column number before which columns will be moved

Returns: ExportedChange[]

# removeColumns

▸ removeColumns(sheetId: number, ...indexes: ColumnRowIndex[]): ExportedChange[]

Defined in src/HyperFormula.ts:1864 (opens new window)

Removes multiple columns from a specified position in a given sheet. Does nothing if columns are outside the effective sheet size.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when the given arguments are invalid

example

const hfInstance = HyperFormula.buildFromArray([
  ['0', '=SUM(1, 2, 3)', '=A1'],
 ]);
@@ -552,7 +552,7 @@
 //   newValue: { error: [CellError], value: '#REF!' },
 // }]
 const changes = hfInstance.removeColumns(0, [0, 1]);
-

Parameters:

Name Type Description
sheetId number sheet ID from which columns will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount]

Returns: ExportedChange[]

# setColumnOrder

▸ setColumnOrder(sheetId: number, newColumnOrder: number[]): ExportedChange[]

Defined in src/HyperFormula.ts:1533 (opens new window)

Reorders columns of a sheet according to a permutation of 0-based indexes. +

Parameters:

Name Type Description
sheetId number sheet ID from which columns will be removed
...indexes ColumnRowIndex[] non-contiguous indexes with format: [column, amount]

Returns: ExportedChange[]

# setColumnOrder

▸ setColumnOrder(sheetId: number, newColumnOrder: number[]): ExportedChange[]

Defined in src/HyperFormula.ts:1533 (opens new window)

Reorders columns of a sheet according to a permutation of 0-based indexes. Parameter newColumnOrder should have a form [ newPositionForColumn0, newPositionForColumn1, newPositionForColumn2, ... ]. This method might be used to sort the columns of a sheet.

Returns an array of cells whose values changed as a result of this operation.

Note: This method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
   ['A', 'B', 'C', 'D']
@@ -563,7 +563,7 @@
 const changes = hfInstance.setColumnOrder(0, newColumnOrder);
 
 // Sheet after this operation: [['A', 'D', 'C', 'B']]
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newColumnOrder number[] permutation of columns

Returns: ExportedChange[]

# swapColumnIndexes

▸ swapColumnIndexes(sheetId: number, columnMapping: [number, number][]): ExportedChange[]

Defined in src/HyperFormula.ts:1460 (opens new window)

Reorders columns of a sheet according to a source-target mapping.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
newColumnOrder number[] permutation of columns

Returns: ExportedChange[]

# swapColumnIndexes

▸ swapColumnIndexes(sheetId: number, columnMapping: [number, number][]): ExportedChange[]

Defined in src/HyperFormula.ts:1460 (opens new window)

Reorders columns of a sheet according to a source-target mapping.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet

throws [[SourceLocationHasArrayError]] when the selected position has array inside

example

const hfInstance = HyperFormula.buildFromArray([
  [1, 2, 4],
  [5]
 ]);
@@ -586,7 +586,7 @@
 //   newValue: null,
 // }]
 const changes = hfInstance.swapColumnIndexes(0, [[0, 2], [2, 0]]);
-

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
columnMapping [number, number][] array mapping original positions to final positions of columns

Returns: ExportedChange[]

# Cells

# doesCellHaveFormula

▸ doesCellHaveFormula(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3175 (opens new window)

Returns true if the specified cell contains a formula. +

Parameters:

Name Type Description
sheetId number ID of a sheet to operate on
columnMapping [number, number][] array mapping original positions to final positions of columns

Returns: ExportedChange[]

# Cells

# doesCellHaveFormula

▸ doesCellHaveFormula(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3175 (opens new window)

Returns true if the specified cell contains a formula. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(A2:A3)', '2'],
 ]);
@@ -596,7 +596,7 @@
 
 // should return 'false' since the B1 cell does not contain a formula
 const B1NoFormula = hfInstance.doesCellHaveFormula({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# doesCellHaveSimpleValue

▸ doesCellHaveSimpleValue(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3144 (opens new window)

Returns true if the specified cell contains a simple value. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# doesCellHaveSimpleValue

▸ doesCellHaveSimpleValue(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3144 (opens new window)

Returns true if the specified cell contains a simple value. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(A2:A3)', '2'],
 ]);
@@ -606,7 +606,7 @@
 
 // should return 'false' since the selected cell does not contain a simple value
 const isB1Simple = hfInstance.doesCellHaveSimpleValue({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# getCellFormula

▸ getCellFormula(cellAddress: SimpleCellAddress): string | undefined

Defined in src/HyperFormula.ts:692 (opens new window)

Returns a normalized formula string from the cell of a given address or undefined for an address that does not exist and empty values.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# getCellFormula

▸ getCellFormula(cellAddress: SimpleCellAddress): string | undefined

Defined in src/HyperFormula.ts:692 (opens new window)

Returns a normalized formula string from the cell of a given address or undefined for an address that does not exist and empty values.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2, 3)', '0'],
 ]);
 
@@ -615,7 +615,7 @@
 
 // should return a normalized B1 cell formula: 'undefined'
 const B1Formula = hfInstance.getCellFormula({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

▸ getCellHyperlink(cellAddress: SimpleCellAddress): string | undefined

Defined in src/HyperFormula.ts:722 (opens new window)

Returns the HYPERLINK url for a cell of a given address or undefined for an address that does not exist or a cell that is not HYPERLINK

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

▸ getCellHyperlink(cellAddress: SimpleCellAddress): string | undefined

Defined in src/HyperFormula.ts:722 (opens new window)

Returns the HYPERLINK url for a cell of a given address or undefined for an address that does not exist or a cell that is not HYPERLINK

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=HYPERLINK("https://hyperformula.handsontable.com/", "HyperFormula")', '0'],
 ]);
 
@@ -624,7 +624,7 @@
 
 // should return 'undefined' for a cell that is not 'HYPERLINK'
 const B1Hyperlink = hfInstance.getCellHyperlink({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

# getCellSerialized

▸ getCellSerialized(cellAddress: SimpleCellAddress): RawCellContent

Defined in src/HyperFormula.ts:754 (opens new window)

Returns [[RawCellContent]] with a serialized content of the cell of a given address: either a cell formula, an explicit value, or an error.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

# getCellSerialized

▸ getCellSerialized(cellAddress: SimpleCellAddress): RawCellContent

Defined in src/HyperFormula.ts:754 (opens new window)

Returns [[RawCellContent]] with a serialized content of the cell of a given address: either a cell formula, an explicit value, or an error.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2, 3)', '0'],
 ]);
 
@@ -633,7 +633,7 @@
 
 // should return serialized content of B1 cell: '0'
 const cellB1Serialized = hfInstance.getCellSerialized({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: RawCellContent

# getCellType

▸ getCellType(cellAddress: SimpleCellAddress): CellType

Defined in src/HyperFormula.ts:3112 (opens new window)

Returns the type of a cell at a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: RawCellContent

# getCellType

▸ getCellType(cellAddress: SimpleCellAddress): CellType

Defined in src/HyperFormula.ts:3112 (opens new window)

Returns the type of a cell at a given address. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(A2:A3)', '2'],
 ]);
@@ -643,7 +643,7 @@
 
 // should return 'VALUE', the cell of given coordinates is of this type
 const cellB1Type = hfInstance.getCellType({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellType

# getCellValue

▸ getCellValue(cellAddress: SimpleCellAddress): CellValue

Defined in src/HyperFormula.ts:661 (opens new window)

Returns the cell value of a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellType

# getCellValue

▸ getCellValue(cellAddress: SimpleCellAddress): CellValue

Defined in src/HyperFormula.ts:661 (opens new window)

Returns the cell value of a given address. Applies rounding and post-processing.

throws [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2, 3)', '2'],
 ]);
@@ -653,7 +653,7 @@
 
 // get value of B1 cell, should be '2'
 const B1Value = hfInstance.getCellValue({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValue

# getCellValueDetailedType

▸ getCellValueDetailedType(cellAddress: SimpleCellAddress): CellValueDetailedType

Defined in src/HyperFormula.ts:3302 (opens new window)

Returns detailed type of the cell value of a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValue

# getCellValueDetailedType

▸ getCellValueDetailedType(cellAddress: SimpleCellAddress): CellValueDetailedType

Defined in src/HyperFormula.ts:3302 (opens new window)

Returns detailed type of the cell value of a given address. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['1%', '1$'],
 ]);
@@ -663,7 +663,7 @@
 
 // should return 'NUMBER_CURRENCY', cell value type of provided coordinates is a number with a format inference currency.
 const cellType = hfInstance.getCellValueDetailedType({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueDetailedType

# getCellValueFormat

▸ getCellValueFormat(cellAddress: SimpleCellAddress): FormatInfo

Defined in src/HyperFormula.ts:3336 (opens new window)

Returns auxiliary format information of the cell value of a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueDetailedType

# getCellValueFormat

▸ getCellValueFormat(cellAddress: SimpleCellAddress): FormatInfo

Defined in src/HyperFormula.ts:3336 (opens new window)

Returns auxiliary format information of the cell value of a given address. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['1$', '1'],
 ]);
@@ -673,7 +673,7 @@
 
 // should return undefined, cell value type of provided coordinates is a number with no format information.
 const cellFormat = hfInstance.getCellValueFormat({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: FormatInfo

# getCellValueType

▸ getCellValueType(cellAddress: SimpleCellAddress): CellValueType

Defined in src/HyperFormula.ts:3268 (opens new window)

Returns type of the cell value of a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: FormatInfo

# getCellValueType

▸ getCellValueType(cellAddress: SimpleCellAddress): CellValueType

Defined in src/HyperFormula.ts:3268 (opens new window)

Returns type of the cell value of a given address. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['=SUM(1, 2, 3)', '2'],
 ]);
@@ -683,7 +683,7 @@
 
 // should return 'NUMBER', cell value type of provided coordinates is a number
 const cellValue = hfInstance.getCellValueType({ sheet: 0, col: 0, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueType

# isCellEmpty

▸ isCellEmpty(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3207 (opens new window)

Returnstrue if the specified cell is empty. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueType

# isCellEmpty

▸ isCellEmpty(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3207 (opens new window)

Returnstrue if the specified cell is empty. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
   [null, '1'],
 ]);
@@ -693,14 +693,14 @@
 
 // should return 'false', cell of provided coordinates is not empty
 const isNotEmpty = hfInstance.isCellEmpty({ sheet: 0, col: 1, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isCellPartOfArray

▸ isCellPartOfArray(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3235 (opens new window)

Returns true if a given cell is a part of an array. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isCellPartOfArray

▸ isCellPartOfArray(cellAddress: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:3235 (opens new window)

Returns true if a given cell is a part of an array. The method accepts cell coordinates as object with column, row and sheet numbers.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if cellAddress is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
    ['{=TRANSPOSE(B1:B1)}'],
 ]);
 
 // should return 'true', cell of provided coordinates is a part of an array
 const isPartOfArray = hfInstance.isCellPartOfArray({ sheet: 0, col: 0, row: 0 });
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isItPossibleToMoveCells

▸ isItPossibleToMoveCells(source: SimpleCellRange, destinationLeftCorner: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:1900 (opens new window)

Returns information whether it is possible to move cells to a specified position in a given sheet. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isItPossibleToMoveCells

▸ isItPossibleToMoveCells(source: SimpleCellRange, destinationLeftCorner: SimpleCellAddress): boolean

Defined in src/HyperFormula.ts:1900 (opens new window)

Returns information whether it is possible to move cells to a specified position in a given sheet. Checks against particular rules to ascertain that moveCells can be called. If returns true, doing moveCells operation won't throw any errors. Returns false if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.

throws [[ExpectedValueOfTypeError]] if destinationLeftCorner, source, or any of basic type arguments are of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
@@ -716,7 +716,7 @@
 // from the corner: column 1 and row 0 of sheet 0
 // into destination corner: column 3, row 0 of sheet 0
 const isMovable = hfInstance.isItPossibleToMoveCells({ start: source, end: source }, destination);
-

Parameters:

Name Type Description
source SimpleCellRange range for a moved block
destinationLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: boolean

# isItPossibleToSetCellContents

▸ isItPossibleToSetCellContents(address: SimpleCellAddress | SimpleCellRange): boolean

Defined in src/HyperFormula.ts:1187 (opens new window)

Returns information whether it is possible to change the content in a rectangular area bounded by the box. +

Parameters:

Name Type Description
source SimpleCellRange range for a moved block
destinationLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: boolean

# isItPossibleToSetCellContents

▸ isItPossibleToSetCellContents(address: SimpleCellAddress | SimpleCellRange): boolean

Defined in src/HyperFormula.ts:1187 (opens new window)

Returns information whether it is possible to change the content in a rectangular area bounded by the box. If returns true, doing setCellContents operation won't throw any errors. Returns false if the address is invalid or the sheet does not exist.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
@@ -730,7 +730,7 @@
 // should return 'true' for this example, it is possible to set content of
 // width 2, height 1 in the first row and column of sheet 0
 const isSettable = hfInstance.isItPossibleToSetCellContents({ start: address1, end: address2 });
-

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange single cell or block of cells to check

Returns: boolean

# moveCells

▸ moveCells(source: SimpleCellRange, destinationLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:1957 (opens new window)

Moves the content of a cell block from source to the target location.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if destinationLeftCorner or source are of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange single cell or block of cells to check

Returns: boolean

# moveCells

▸ moveCells(source: SimpleCellRange, destinationLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:1957 (opens new window)

Moves the content of a cell block from source to the target location.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if destinationLeftCorner or source are of wrong type

throws [[InvalidArgumentsError]] when the given arguments are invalid

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved

throws [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
  ['=RAND()', '42'],
 ]);
 
@@ -745,7 +745,7 @@
 //   newValue: 0.93524248002062,
 // }]
 const changes = hfInstance.moveCells({ start: source, end: source }, destination);
-

Parameters:

Name Type Description
source SimpleCellRange range for a moved block
destinationLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# setCellContents

▸ setCellContents(topLeftCornerAddress: SimpleCellAddress, cellContents: RawCellContent[][] | RawCellContent): ExportedChange[]

Defined in src/HyperFormula.ts:1240 (opens new window)

Sets the content for a block of cells of a given coordinates.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when the value is not an array of arrays or a raw cell value

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[ExpectedValueOfTypeError]] if topLeftCornerAddress argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
source SimpleCellRange range for a moved block
destinationLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# setCellContents

▸ setCellContents(topLeftCornerAddress: SimpleCellAddress, cellContents: RawCellContent[][] | RawCellContent): ExportedChange[]

Defined in src/HyperFormula.ts:1240 (opens new window)

Sets the content for a block of cells of a given coordinates.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[InvalidArgumentsError]] when the value is not an array of arrays or a raw cell value

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[ExpectedValueOfTypeError]] if topLeftCornerAddress argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2', '=A1'],
 ]);
 
@@ -755,7 +755,7 @@
 //   newValue: 2,
 // }]
 const changes = hfInstance.setCellContents({ col: 3, row: 0, sheet: 0 }, [['=B1']]);
-

Parameters:

Name Type Description
topLeftCornerAddress SimpleCellAddress top left corner of block of cells
cellContents RawCellContent[][] | RawCellContent array with content

Returns: ExportedChange[]

# Named Expressions

# addNamedExpression

▸ addNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number, options?: NamedExpressionOptions): ExportedChange[]

Defined in src/HyperFormula.ts:3653 (opens new window)

Adds a specified named expression.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionAdded always, unless batch mode is used

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionNameIsAlreadyTakenError]] when the named-expression name is not available.

throws [[NamedExpressionNameIsInvalidError]] when the named-expression name is not valid

throws [[NoRelativeAddressesAllowedError]] when the named-expression formula contains relative references

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
topLeftCornerAddress SimpleCellAddress top left corner of block of cells
cellContents RawCellContent[][] | RawCellContent array with content

Returns: ExportedChange[]

# Named Expressions

# addNamedExpression

▸ addNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number, options?: NamedExpressionOptions): ExportedChange[]

Defined in src/HyperFormula.ts:3653 (opens new window)

Adds a specified named expression.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionAdded always, unless batch mode is used

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionNameIsAlreadyTakenError]] when the named-expression name is not available.

throws [[NamedExpressionNameIsInvalidError]] when the named-expression name is not valid

throws [[NoRelativeAddressesAllowedError]] when the named-expression formula contains relative references

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -767,7 +767,7 @@
 //   newValue: 142,
 // }]
 const changes = hfInstance.addNamedExpression('prettyName', '=Sheet1!$A$1+100', 0);
-

Parameters:

Name Type Description
expressionName string a name of the expression to be added
expression RawCellContent the expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope
options? NamedExpressionOptions additional metadata related to named expression

Returns: ExportedChange[]

# changeNamedExpression

▸ changeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number, options?: NamedExpressionOptions): ExportedChange[]

Defined in src/HyperFormula.ts:3869 (opens new window)

Changes a given named expression to a specified formula.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionDoesNotExistError]] when the given expression does not exist.

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

throws [[ArrayFormulasNotSupportedError]] when the named expression formula is an array formula

throws [[NoRelativeAddressesAllowedError]] when the named expression formula contains relative references

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string a name of the expression to be added
expression RawCellContent the expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope
options? NamedExpressionOptions additional metadata related to named expression

Returns: ExportedChange[]

# changeNamedExpression

▸ changeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number, options?: NamedExpressionOptions): ExportedChange[]

Defined in src/HyperFormula.ts:3869 (opens new window)

Changes a given named expression to a specified formula.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionDoesNotExistError]] when the given expression does not exist.

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

throws [[ArrayFormulasNotSupportedError]] when the named expression formula is an array formula

throws [[NoRelativeAddressesAllowedError]] when the named expression formula contains relative references

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -776,7 +776,7 @@
 
 // change the named expression
 const changes = hfInstance.changeNamedExpression('prettyName', '=Sheet1!$A$1+200');
-

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
newExpression RawCellContent a new expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope
options? NamedExpressionOptions additional metadata related to named expression

Returns: ExportedChange[]

# getAllNamedExpressionsSerialized

▸ getAllNamedExpressionsSerialized(): SerializedNamedExpression[]

Defined in src/HyperFormula.ts:4033 (opens new window)

Returns all named expressions serialized.

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
newExpression RawCellContent a new expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope
options? NamedExpressionOptions additional metadata related to named expression

Returns: ExportedChange[]

# getAllNamedExpressionsSerialized

▸ getAllNamedExpressionsSerialized(): SerializedNamedExpression[]

Defined in src/HyperFormula.ts:4033 (opens new window)

Returns all named expressions serialized.

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
  ['50'],
  ['60'],
@@ -795,7 +795,7 @@
 // {name: 'alsoPrettyName', expression: '=Sheet1!$A$3+100', options: undefined, scope: 0}
 // ]
 const allExpressions = hfInstance.getAllNamedExpressionsSerialized();
-

Returns: SerializedNamedExpression[]

# getNamedExpression

▸ getNamedExpression(expressionName: string, scope?: undefined | number): NamedExpression | undefined

Defined in src/HyperFormula.ts:3772 (opens new window)

Returns a named expression, or undefined for a named expression that does not exist or does not hold a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: SerializedNamedExpression[]

# getNamedExpression

▸ getNamedExpression(expressionName: string, scope?: undefined | number): NamedExpression | undefined

Defined in src/HyperFormula.ts:3772 (opens new window)

Returns a named expression, or undefined for a named expression that does not exist or does not hold a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -809,7 +809,7 @@
 
 // for a named expression that doesn't exist, returns 'undefined':
 const myFormulaTwo = hfInstance.getNamedExpression('uglyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: NamedExpression | undefined

# getNamedExpressionFormula

▸ getNamedExpressionFormula(expressionName: string, scope?: undefined | number): string | undefined

Defined in src/HyperFormula.ts:3729 (opens new window)

Returns a normalized formula string for given named expression, or undefined for a named expression that does not exist or does not hold a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: NamedExpression | undefined

# getNamedExpressionFormula

▸ getNamedExpressionFormula(expressionName: string, scope?: undefined | number): string | undefined

Defined in src/HyperFormula.ts:3729 (opens new window)

Returns a normalized formula string for given named expression, or undefined for a named expression that does not exist or does not hold a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -819,7 +819,7 @@
 // returns a normalized formula string corresponding to the passed name from 'Sheet1' (sheetId=0),
 // '=Sheet1!A1+100' for this example
 const myFormula = hfInstance.getNamedExpressionFormula('prettyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: string | undefined

# getNamedExpressionValue

▸ getNamedExpressionValue(expressionName: string, scope?: undefined | number): CellValue | undefined

Defined in src/HyperFormula.ts:3689 (opens new window)

Gets specified named expression value. +

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: string | undefined

# getNamedExpressionValue

▸ getNamedExpressionValue(expressionName: string, scope?: undefined | number): CellValue | undefined

Defined in src/HyperFormula.ts:3689 (opens new window)

Gets specified named expression value. Returns a [[CellValue]] or undefined if the given named expression does not exist.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
@@ -829,7 +829,7 @@
 
 // returns the calculated value of a passed named expression, '142' for this example
 const myFormula = hfInstance.getNamedExpressionValue('prettyName', 'Sheet1');
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: CellValue | undefined

# isItPossibleToAddNamedExpression

▸ isItPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3601 (opens new window)

Returns information whether it is possible to add named expression into a specific scope. +

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: CellValue | undefined

# isItPossibleToAddNamedExpression

▸ isItPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3601 (opens new window)

Returns information whether it is possible to add named expression into a specific scope. Checks against particular rules to ascertain that addNamedExpression can be called. If returns true, doing addNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -839,7 +839,7 @@
 // should return 'true' for this example,
 // it is possible to add named expression to global scope
 const isAddable = hfInstance.isItPossibleToAddNamedExpression('prettyName', '=Sheet1!$A$1+100');
-

Parameters:

Name Type Description
expressionName string a name of the expression to be added
expression RawCellContent the expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# isItPossibleToChangeNamedExpression

▸ isItPossibleToChangeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3821 (opens new window)

Returns information whether it is possible to change named expression in a specific scope. +

Parameters:

Name Type Description
expressionName string a name of the expression to be added
expression RawCellContent the expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# isItPossibleToChangeNamedExpression

▸ isItPossibleToChangeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3821 (opens new window)

Returns information whether it is possible to change named expression in a specific scope. Checks against particular rules to ascertain that changeNamedExpression can be called. If returns true, doing changeNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -852,7 +852,7 @@
 // should return 'true' for this example,
 // it is possible to change named expression
 const isAddable = hfInstance.isItPossibleToChangeNamedExpression('prettyName', '=Sheet1!$A$1+100');
-

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
newExpression RawCellContent a new expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# isItPossibleToRemoveNamedExpression

▸ isItPossibleToRemoveNamedExpression(expressionName: string, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3905 (opens new window)

Returns information whether it is possible to remove named expression from a specific scope. +

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
newExpression RawCellContent a new expression
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# isItPossibleToRemoveNamedExpression

▸ isItPossibleToRemoveNamedExpression(expressionName: string, scope?: undefined | number): boolean

Defined in src/HyperFormula.ts:3905 (opens new window)

Returns information whether it is possible to remove named expression from a specific scope. Checks against particular rules to ascertain that removeNamedExpression can be called. If returns true, doing removeNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
@@ -865,7 +865,7 @@
 // should return 'true' for this example,
 // it is possible to change named expression
 const isAddable = hfInstance.isItPossibleToRemoveNamedExpression('prettyName');
-

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# listNamedExpressions

▸ listNamedExpressions(scope?: undefined | number): string[]

Defined in src/HyperFormula.ts:3997 (opens new window)

Lists named expressions.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# listNamedExpressions

▸ listNamedExpressions(scope?: undefined | number): string[]

Defined in src/HyperFormula.ts:3997 (opens new window)

Lists named expressions.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
  ['50'],
  ['60'],
@@ -881,7 +881,7 @@
 
  // list the expressions, should return: ['alsoPrettyName'] for this example
 const listOfExpressions = hfInstance.listNamedExpressions(0);
-

Parameters:

Name Type Description
scope? undefined | number scope of the named expressions, sheetId for local scope or undefined for global scope

Returns: string[]

# removeNamedExpression

▸ removeNamedExpression(expressionName: string, scope?: undefined | number): ExportedChange[]

Defined in src/HyperFormula.ts:3950 (opens new window)

Removes a named expression.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionRemoved after the expression was removed

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionDoesNotExistError]] when the given expression does not exist.

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
scope? undefined | number scope of the named expressions, sheetId for local scope or undefined for global scope

Returns: string[]

# removeNamedExpression

▸ removeNamedExpression(expressionName: string, scope?: undefined | number): ExportedChange[]

Defined in src/HyperFormula.ts:3950 (opens new window)

Removes a named expression.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionRemoved after the expression was removed

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionDoesNotExistError]] when the given expression does not exist.

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -890,7 +890,7 @@
 
 // remove the named expression
 const changes = hfInstance.removeNamedExpression('prettyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: ExportedChange[]

# Helpers

# calculateFormula

▸ calculateFormula(formulaString: string, sheetId: number): CellValue | CellValue[][]

Defined in src/HyperFormula.ts:4098 (opens new window)

Calculates fire-and-forget formula, returns the calculated value.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with =).

throws [[NoSheetWithIdError]] when the provided sheetID doesn't exist.

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: ExportedChange[]

# Helpers

# calculateFormula

▸ calculateFormula(formulaString: string, sheetId: number): CellValue | CellValue[][]

Defined in src/HyperFormula.ts:4098 (opens new window)

Calculates fire-and-forget formula, returns the calculated value.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with =).

throws [[NoSheetWithIdError]] when the provided sheetID doesn't exist.

example

const hfInstance = HyperFormula.buildFromSheets({
  Sheet1: [['58']],
  Sheet2: [['1', '2', '3'], ['4', '5', '6']]
 });
@@ -901,20 +901,20 @@
 
 // for this example, returns [['11', '12', '13'], ['14', '15', '16']]
 const calculatedFormula = hfInstance.calculateFormula('=A1:B3+10', 1);
-

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.
sheetId number The ID of a sheet in context of which the formula gets evaluated.

Returns: CellValue | CellValue[][]

# getCellDependents

▸ getCellDependents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2939 (opens new window)

Returns all the out-neighbors in the dependency graph for a given cell address or range. Including:

The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "Optimizations for large ranges".

The returned array includes also named expression dependents. They are represented as cell references with sheet ID -1.

throws [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
+

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.
sheetId number The ID of a sheet in context of which the formula gets evaluated.

Returns: CellValue | CellValue[][]

# getCellDependents

▸ getCellDependents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2939 (opens new window)

Returns all the out-neighbors in the dependency graph for a given cell address or range. Including:

The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "Optimizations for large ranges".

The returned array includes also named expression dependents. They are represented as cell references with sheet ID -1.

throws [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
 
 hfInstance.getCellDependents({ sheet: 0, col: 0, row: 0});
 // returns [{ sheet: 0, col: 1, row: 0}, { sheet: 0, col: 2, row: 0}]
-

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getCellPrecedents

▸ getCellPrecedents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2977 (opens new window)

Returns all the in-neighbors in the dependency graph for a given cell address or range. In particular:

The returned array includes also named expression precedents. They are represented as cell references with sheet ID -1.

throws [[ExpectedValueOfTypeError]] if address is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
+

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getCellPrecedents

▸ getCellPrecedents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2977 (opens new window)

Returns all the in-neighbors in the dependency graph for a given cell address or range. In particular:

The returned array includes also named expression precedents. They are represented as cell references with sheet ID -1.

throws [[ExpectedValueOfTypeError]] if address is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
 
 hfInstance.getCellPrecedents({ sheet: 0, col: 2, row: 0});
 // returns [{ sheet: 0, col: 0, row: 0}, { sheet: 0, col: 1, row: 0}]
-

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getNamedExpressionsFromFormula

▸ getNamedExpressionsFromFormula(formulaString: string): string[]

Defined in src/HyperFormula.ts:4129 (opens new window)

Return a list of named expressions used by a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with =).

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getNamedExpressionsFromFormula

▸ getNamedExpressionsFromFormula(formulaString: string): string[]

Defined in src/HyperFormula.ts:4129 (opens new window)

Return a list of named expressions used by a formula.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with =).

example

const hfInstance = HyperFormula.buildEmpty();
 
 // returns a list of named expressions used by a formula
 // for this example, returns ['foo', 'bar']
 const namedExpressions = hfInstance.getNamedExpressionsFromFormula('=foo+bar*2');
-

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.

Returns: string[]

# normalizeFormula

▸ normalizeFormula(formulaString: string): string

Defined in src/HyperFormula.ts:4062 (opens new window)

Parses and then unparses a formula. +

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.

Returns: string[]

# normalizeFormula

▸ normalizeFormula(formulaString: string): string

Defined in src/HyperFormula.ts:4062 (opens new window)

Parses and then unparses a formula. Returns a normalized formula (e.g., restores the original capitalization of sheet names, function names, cell addresses, and named expressions).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NotAFormulaError]] when the provided string is not a valid formula, i.e., does not start with "="

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
  ['50'],
@@ -925,25 +925,25 @@
 
 // returns '=3*$A$1'
 const normalizedFormula = hfInstance.normalizeFormula('=3*$a$1');
-

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: string

# numberToDate

▸ numberToDate(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4278 (opens new window)

Interprets number as a date.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: string

# numberToDate

▸ numberToDate(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4278 (opens new window)

Interprets number as a date.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass the number of days since nullDate
 // the method should return formatted date, for this example:
 // {year: 2020, month: 1, day: 15}
 const dateFromNumber = hfInstance.numberToDate(43845);
-

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are ignored.

Returns: DateTime

# numberToDateTime

▸ numberToDateTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4254 (opens new window)

Interprets number as a date + time.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are ignored.

Returns: DateTime

# numberToDateTime

▸ numberToDateTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4254 (opens new window)

Interprets number as a date + time.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass the number of days since nullDate
 // the method should return formatted date and time, for this example:
 // {year: 2020, month: 1, day: 15, hours: 2, minutes: 24, seconds: 0}
 const dateTimeFromNumber = hfInstance.numberToDateTime(43845.1);
 
-

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.

Returns: DateTime

# numberToTime

▸ numberToTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4301 (opens new window)

Interprets number as a time (hours/minutes/seconds).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.

Returns: DateTime

# numberToTime

▸ numberToTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4301 (opens new window)

Interprets number as a time (hours/minutes/seconds).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass a number to be interpreted as a time
 // should return {hours: 26, minutes: 24} for this example
 const timeFromNumber = hfInstance.numberToTime(1.1);
-

Parameters:

Name Type Description
inputNumber number time in 24h units.

Returns: DateTime

# simpleCellAddressFromString

▸ simpleCellAddressFromString(cellAddress: string, contextSheetId: number): SimpleCellAddress | undefined

Defined in src/HyperFormula.ts:2821 (opens new window)

Computes the simple (absolute) address of a cell address, based on its string representation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
inputNumber number time in 24h units.

Returns: DateTime

# simpleCellAddressFromString

▸ simpleCellAddressFromString(cellAddress: string, contextSheetId: number): SimpleCellAddress | undefined

Defined in src/HyperFormula.ts:2821 (opens new window)

Computes the simple (absolute) address of a cell address, based on its string representation.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
 // returns { sheet: 0, col: 0, row: 0 }
@@ -957,18 +957,18 @@
 
 // returns 'undefined', as there's no 'Sheet 2' in the HyperFormula instance
 const simpleCellAddress = hfInstance.simpleCellAddressFromString('Sheet2!A6');
-

Parameters:

Name Type Description
cellAddress string string representation of cell address in A1 notation
contextSheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellAddress | undefined

# simpleCellAddressToString

▸ simpleCellAddressToString(cellAddress: SimpleCellAddress, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2873 (opens new window)

Returns string representation of an absolute address in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
cellAddress string string representation of cell address in A1 notation
contextSheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellAddress | undefined

# simpleCellAddressToString

▸ simpleCellAddressToString(cellAddress: SimpleCellAddress, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2873 (opens new window)

Returns string representation of an absolute address in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
 // should return 'B2'
 const A1Notation = hfInstance.simpleCellAddressToString({ sheet: 0, col: 1, row: 1 }, 0);
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress object representation of an absolute address
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# simpleCellRangeFromString

▸ simpleCellRangeFromString(cellRange: string, sheetId: number): SimpleCellRange | undefined

Defined in src/HyperFormula.ts:2848 (opens new window)

Computes simple (absolute) address of a cell range based on its string representation. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress object representation of an absolute address
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# simpleCellRangeFromString

▸ simpleCellRangeFromString(cellRange: string, sheetId: number): SimpleCellRange | undefined

Defined in src/HyperFormula.ts:2848 (opens new window)

Computes simple (absolute) address of a cell range based on its string representation. If sheet name is present in string representation but not present in the engine, returns undefined.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
 // should return { start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 0 } }
 const simpleCellAddress = hfInstance.simpleCellRangeFromString('A1:A2', 0);
-

Parameters:

Name Type Description
cellRange string string representation of cell range in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellRange | undefined

# simpleCellRangeToString

▸ simpleCellRangeToString(cellRange: SimpleCellRange, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2906 (opens new window)

Returns string representation of an absolute range in A1 notation or undefined if the sheet index is not present in the engine.

Note: This method is useful only for cell ranges; does not work with column ranges and row ranges.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
cellRange string string representation of cell range in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellRange | undefined

# simpleCellRangeToString

▸ simpleCellRangeToString(cellRange: SimpleCellRange, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2906 (opens new window)

Returns string representation of an absolute range in A1 notation or undefined if the sheet index is not present in the engine.

Note: This method is useful only for cell ranges; does not work with column ranges and row ranges.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 hfInstance.addSheet('Sheet1'); //sheetId = 1
 
@@ -977,13 +977,13 @@
 
  // should return 'Sheet1!B2:C2'
 const another = hfInstance.simpleCellRangeToString({ start: { sheet: 1, col: 1, row: 1 }, end: { sheet: 1, col: 2, row: 1 } }, 0);
-

Parameters:

Name Type Description
cellRange SimpleCellRange object representation of an absolute range
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# validateFormula

▸ validateFormula(formulaString: string): boolean

Defined in src/HyperFormula.ts:4163 (opens new window)

Validates the formula. +

Parameters:

Name Type Description
cellRange SimpleCellRange object representation of an absolute range
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# validateFormula

▸ validateFormula(formulaString: string): boolean

Defined in src/HyperFormula.ts:4163 (opens new window)

Validates the formula. If the provided string starts with "=" and is a parsable formula, the method returns true. The validation is purely grammatical: the method doesn't verify if the formula can be calculated or not.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// checks if the given string is a valid formula, should return 'true' for this example
 const isFormula = hfInstance.validateFormula('=SUM(1, 2)');
-

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: boolean

# Clipboard

# clearClipboard

▸ clearClipboard(): void

Defined in src/HyperFormula.ts:2303 (opens new window)

Clears the clipboard content.

example

// clears the clipboard, isClipboardEmpty() should return true if called afterwards
+

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: boolean

# Clipboard

# clearClipboard

▸ clearClipboard(): void

Defined in src/HyperFormula.ts:2303 (opens new window)

Clears the clipboard content.

example

// clears the clipboard, isClipboardEmpty() should return true if called afterwards
 hfInstance.clearClipboard();
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: void

# copy

▸ copy(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2167 (opens new window)

Stores a copy of the cell block in internal clipboard for the further paste. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: void

# copy

▸ copy(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2167 (opens new window)

Stores a copy of the cell block in internal clipboard for the further paste. Returns the copied values for use in external clipboard.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2'],
 ]);
@@ -993,7 +993,7 @@
   start: { sheet: 0, col: 1, row: 0 },
   end: { sheet: 0, col: 1, row: 0 },
 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to copy

Returns: CellValue[][]

# cut

▸ cut(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2205 (opens new window)

Stores information of the cell block in internal clipboard for further paste. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to copy

Returns: CellValue[][]

# cut

▸ cut(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2205 (opens new window)

Stores information of the cell block in internal clipboard for further paste. Calling paste right after this method is equivalent to call moveCells. Almost any CRUD operation called after this method will abort the cut operation. Returns the cut values for use in external clipboard.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
@@ -1005,7 +1005,7 @@
   start: { sheet: 0, col: 0, row: 0 },
   end: { sheet: 0, col: 0, row: 0 },
 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to cut

Returns: CellValue[][]

# isClipboardEmpty

▸ isClipboardEmpty(): boolean

Defined in src/HyperFormula.ts:2286 (opens new window)

Returns information whether there is something in the clipboard.

example

const hfInstance = HyperFormula.buildFromArray([
+

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to cut

Returns: CellValue[][]

# isClipboardEmpty

▸ isClipboardEmpty(): boolean

Defined in src/HyperFormula.ts:2286 (opens new window)

Returns information whether there is something in the clipboard.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
 ]);
 
@@ -1017,7 +1017,7 @@
 
 // returns 'false', there is content in the clipboard
 const isClipboardEmpty = hfInstance.isClipboardEmpty();
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: boolean

# paste

▸ paste(targetLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:2254 (opens new window)

When called after copy it pastes copied values and formulas into a cell block. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: boolean

# paste

▸ paste(targetLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:2254 (opens new window)

When called after copy it pastes copied values and formulas into a cell block. When called after cut it performs moveCells operation into the cell block. Does nothing if the clipboard is empty.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[NothingToPasteError]] when clipboard is empty

throws [[TargetLocationHasArrayError]] when the selected target area has array inside

throws [[ExpectedValueOfTypeError]] if targetLeftCorner is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2'],
@@ -1031,7 +1031,7 @@
 
 // returns a list of modified cells: their absolute addresses and new values
 const changes = hfInstance.paste({ sheet: 0, col: 1, row: 0 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
targetLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# Undo and Redo

# clearRedoStack

▸ clearRedoStack(): void

Defined in src/HyperFormula.ts:2331 (opens new window)

Clears the redo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
+

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
targetLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# Undo and Redo

# clearRedoStack

▸ clearRedoStack(): void

Defined in src/HyperFormula.ts:2331 (opens new window)

Clears the redo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '3'],
 ]);
 
@@ -1046,7 +1046,7 @@
 
 // clear the redo stack
 hfInstance.clearRedoStack();
-

Returns: void

# clearUndoStack

▸ clearUndoStack(): void

Defined in src/HyperFormula.ts:2356 (opens new window)

Clears the undo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: void

# clearUndoStack

▸ clearUndoStack(): void

Defined in src/HyperFormula.ts:2356 (opens new window)

Clears the undo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '3'],
 ]);
 
@@ -1058,11 +1058,11 @@
 
 // clear the undo stack
 hfInstance.clearUndoStack();
-

Returns: void

# isThereSomethingToRedo

▸ isThereSomethingToRedo(): boolean

Defined in src/HyperFormula.ts:1155 (opens new window)

Checks if there is at least one operation that can be re-done.

example

hfInstance.undo();
+

Returns: void

# isThereSomethingToRedo

▸ isThereSomethingToRedo(): boolean

Defined in src/HyperFormula.ts:1155 (opens new window)

Checks if there is at least one operation that can be re-done.

example

hfInstance.undo();
 
 // when there is an action to redo, this returns 'true'
 const isSomethingToRedo = hfInstance.isThereSomethingToRedo();
-

Returns: boolean

# isThereSomethingToUndo

▸ isThereSomethingToUndo(): boolean

Defined in src/HyperFormula.ts:1138 (opens new window)

Checks if there is at least one operation that can be undone.

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: boolean

# isThereSomethingToUndo

▸ isThereSomethingToUndo(): boolean

Defined in src/HyperFormula.ts:1138 (opens new window)

Checks if there is at least one operation that can be undone.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
  ['3'],
@@ -1074,7 +1074,7 @@
 // should return 'true', it is possible to undo last operation
 // which is removing rows in this example
 const isSomethingToUndo = hfInstance.isThereSomethingToUndo();
-

Returns: boolean

# redo

▸ redo(): ExportedChange[]

Defined in src/HyperFormula.ts:1112 (opens new window)

Re-do recently undone operation.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToRedoError]] when there is no operation running that can be re-done

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: boolean

# redo

▸ redo(): ExportedChange[]

Defined in src/HyperFormula.ts:1112 (opens new window)

Re-do recently undone operation.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToRedoError]] when there is no operation running that can be re-done

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
  ['3'],
@@ -1088,7 +1088,7 @@
 
 // do a redo, it should return the values after removing the second row: [['1'], ['3']]
 const changes = hfInstance.redo();
-

Returns: ExportedChange[]

# undo

▸ undo(): ExportedChange[]

Defined in src/HyperFormula.ts:1076 (opens new window)

Undo the previous operation.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToUndoError]] when there is no operation running that can be undone

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: ExportedChange[]

# undo

▸ undo(): ExportedChange[]

Defined in src/HyperFormula.ts:1076 (opens new window)

Undo the previous operation.

Returns an array of cells whose values changed as a result of this operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToUndoError]] when there is no operation running that can be undone

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
  ['3', ''],
 ]);
@@ -1098,7 +1098,7 @@
 
 // undo the operation, it should return the changes
 const changes = hfInstance.undo();
-

Returns: ExportedChange[]

# Batch

# batch

▸ batch(batchOperations: function): ExportedChange[]

Defined in src/HyperFormula.ts:3463 (opens new window)

Runs the provided callback as a single batch operation and returns the changed cells.

Returns an array of cells whose values changed as a result of all batched operations.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationSuspended always

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
+

Returns: ExportedChange[]

# Batch

# batch

▸ batch(batchOperations: function): ExportedChange[]

Defined in src/HyperFormula.ts:3463 (opens new window)

Runs the provided callback as a single batch operation and returns the changed cells.

Returns an array of cells whose values changed as a result of all batched operations.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationSuspended always

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
 });
@@ -1110,7 +1110,7 @@
  hfInstance.setCellContents({ col: 3, row: 0, sheet: 0 }, [['=B1']]);
  hfInstance.setCellContents({ col: 4, row: 0, sheet: 0 }, [['=A1']]);
 });
-

Parameters:

▪ batchOperations: function

a function with operations to be performed

▸ (): void

Returns: ExportedChange[]

# isEvaluationSuspended

▸ isEvaluationSuspended(): boolean

Defined in src/HyperFormula.ts:3572 (opens new window)

Checks if the dependency graph recalculation process is suspended or not.

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

▪ batchOperations: function

a function with operations to be performed

▸ (): void

Returns: ExportedChange[]

# isEvaluationSuspended

▸ isEvaluationSuspended(): boolean

Defined in src/HyperFormula.ts:3572 (opens new window)

Checks if the dependency graph recalculation process is suspended or not.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // suspend the evaluation
 hfInstance.suspendEvaluation();
@@ -1120,7 +1120,7 @@
 const isEvaluationSuspended = hfInstance.isEvaluationSuspended();
 
 const changes = hfInstance.resumeEvaluation();
-

Returns: boolean

# resumeEvaluation

▸ resumeEvaluation(): ExportedChange[]

Defined in src/HyperFormula.ts:3546 (opens new window)

Resumes the dependency graph recalculation that was suspended with suspendEvaluation. +

Returns: boolean

# resumeEvaluation

▸ resumeEvaluation(): ExportedChange[]

Defined in src/HyperFormula.ts:3546 (opens new window)

Resumes the dependency graph recalculation that was suspended with suspendEvaluation. It also triggers the recalculation and returns an array of cells whose values changed as a result of all batched operations.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
@@ -1139,7 +1139,7 @@
 
 // resume the evaluation
 const changes = hfInstance.resumeEvaluation();
-

Returns: ExportedChange[]

# suspendEvaluation

▸ suspendEvaluation(): void

Defined in src/HyperFormula.ts:3510 (opens new window)

Suspends the dependency graph recalculation to start a batch operation. +

Returns: ExportedChange[]

# suspendEvaluation

▸ suspendEvaluation(): void

Defined in src/HyperFormula.ts:3510 (opens new window)

Suspends the dependency graph recalculation to start a batch operation. It allows optimizing the performance. With this method, multiple CRUD operations can be done without triggering recalculation after every operation. Suspending evaluation should result in an overall faster calculation compared to recalculating after each operation separately. @@ -1161,7 +1161,7 @@ // use resumeEvaluation to resume const changes = hfInstance.resumeEvaluation(); -

Returns: void

# Events

# off

▸ off‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4387 (opens new window)

Unsubscribes from an event or from all events. +

Returns: void

# Events

# off

▸ off‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4387 (opens new window)

Unsubscribes from an event or from all events. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // define a simple function to be called upon emitting an event
@@ -1179,7 +1179,7 @@
 
 // add a sheet, the console should not print anything
 hfInstance.addSheet('FooBaz');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# on

▸ on‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4327 (opens new window)

Subscribes to an event. +

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# on

▸ on‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4327 (opens new window)

Subscribes to an event. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // subscribe to a 'sheetAdded', pass a simple handler
@@ -1188,7 +1188,7 @@
 // add a sheet to trigger an event,
 // console should print 'foo' after each time sheet is added in this example
 hfInstance.addSheet('FooBar');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# once

▸ once‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4353 (opens new window)

Subscribes to an event once. +

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# once

▸ once‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4353 (opens new window)

Subscribes to an event once. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // subscribe to a 'sheetAdded', pass a simple handler
@@ -1198,11 +1198,11 @@
 // console should print 'foo' only once when the sheet is added in this example
 hfInstance.addSheet('FooBar');
 hfInstance.addSheet('FooBaz');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# Custom Functions

# getAllFunctionPlugins

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:4230 (opens new window)

Returns classes of all plugins registered in this instance of HyperFormula

example

const hfInstance = HyperFormula.buildEmpty();
+

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# Custom Functions

# getAllFunctionPlugins

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:4230 (opens new window)

Returns classes of all plugins registered in this instance of HyperFormula

example

const hfInstance = HyperFormula.buildEmpty();
 
 // return classes of all plugins registered, assign to a variable
 const allNames = hfInstance.getAllFunctionPlugins();
-

Returns: FunctionPluginDefinition[]

# getFunctionPlugin

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:4212 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Returns: FunctionPluginDefinition[]

# getFunctionPlugin

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:4212 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 const hfInstance = HyperFormula.buildEmpty();
@@ -1212,14 +1212,14 @@
 
 // get the plugin
 const myPlugin = hfInstance.getFunctionPlugin('EXAMPLE');
-

Parameters:

Name Type Description
functionId string id of a function, e.g., 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getRegisteredFunctionNames

▸ getRegisteredFunctionNames(): string[]

Defined in src/HyperFormula.ts:4184 (opens new window)

Returns translated names of all functions registered in this instance of HyperFormula +

Parameters:

Name Type Description
functionId string id of a function, e.g., 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getRegisteredFunctionNames

▸ getRegisteredFunctionNames(): string[]

Defined in src/HyperFormula.ts:4184 (opens new window)

Returns translated names of all functions registered in this instance of HyperFormula according to the language set in the configuration

example

const hfInstance = HyperFormula.buildEmpty();
 
 // return translated names of all functions, assign to a variable
 const allNames = hfInstance.getRegisteredFunctionNames();
-

Returns: string[]

# Static Methods

# getAllFunctionPlugins Static

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:613 (opens new window)

Returns classes of all plugins registered in HyperFormula.

example

// return classes of all plugins
+

Returns: string[]

# Static Methods

# getAllFunctionPlugins Static

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:613 (opens new window)

Returns classes of all plugins registered in HyperFormula.

example

// return classes of all plugins
 const allClasses = HyperFormula.getAllFunctionPlugins();
-

Returns: FunctionPluginDefinition[]

# getFunctionPlugin Static

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:597 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Returns: FunctionPluginDefinition[]

# getFunctionPlugin Static

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:597 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a plugin
@@ -1227,29 +1227,29 @@
 
 // return the class of a given plugin
 const myFunctionClass = HyperFormula.getFunctionPlugin('EXAMPLE');
-

Parameters:

Name Type Description
functionId string id of a function, e.g., 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getLanguage Static

▸ getLanguage(languageCode: string): TranslationPackage

Defined in src/HyperFormula.ts:348 (opens new window)

Returns registered language from its code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when trying to retrieve not registered language

example

// return registered language
+

Parameters:

Name Type Description
functionId string id of a function, e.g., 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getLanguage Static

▸ getLanguage(languageCode: string): TranslationPackage

Defined in src/HyperFormula.ts:348 (opens new window)

Returns registered language from its code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when trying to retrieve not registered language

example

// return registered language
 const language = HyperFormula.getLanguage('enGB');
-

Parameters:

Name Type Description
languageCode string code string of the translation package

Returns: TranslationPackage

# getRegisteredFunctionNames Static

▸ getRegisteredFunctionNames(code: string): string[]

Defined in src/HyperFormula.ts:569 (opens new window)

Returns translated names of all registered functions for a given language

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// return a list of function names registered for enGB
+

Parameters:

Name Type Description
languageCode string code string of the translation package

Returns: TranslationPackage

# getRegisteredFunctionNames Static

▸ getRegisteredFunctionNames(code: string): string[]

Defined in src/HyperFormula.ts:569 (opens new window)

Returns translated names of all registered functions for a given language

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// return a list of function names registered for enGB
 const allNames = HyperFormula.getRegisteredFunctionNames('enGB');
-

Parameters:

Name Type Description
code string language code

Returns: string[]

# getRegisteredLanguagesCodes Static

▸ getRegisteredLanguagesCodes(): string[]

Defined in src/HyperFormula.ts:427 (opens new window)

Returns all registered languages codes.

example

// should return all registered language codes: ['enGB', 'plPL']
+

Parameters:

Name Type Description
code string language code

Returns: string[]

# getRegisteredLanguagesCodes Static

▸ getRegisteredLanguagesCodes(): string[]

Defined in src/HyperFormula.ts:427 (opens new window)

Returns all registered languages codes.

example

// should return all registered language codes: ['enGB', 'plPL']
 const registeredLanguages = HyperFormula.getRegisteredLanguagesCodes();
-

Returns: string[]

# registerFunction Static

▸ registerFunction(functionId: string, plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:505 (opens new window)

Registers a function with a given id if such exists in a plugin.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
+

Returns: string[]

# registerFunction Static

▸ registerFunction(functionId: string, plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:505 (opens new window)

Registers a function with a given id if such exists in a plugin.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a function
 HyperFormula.registerFunction('EXAMPLE', MyExamplePlugin);
-

Parameters:

Name Type Description
functionId string function id, e.g., 'SUMIF'
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage translations for the function name

Returns: void

# registerFunctionPlugin Static

▸ registerFunctionPlugin(plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:455 (opens new window)

Registers all functions in a given plugin with optional translations.

Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used. +

Parameters:

Name Type Description
functionId string function id, e.g., 'SUMIF'
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage translations for the function name

Returns: void

# registerFunctionPlugin Static

▸ registerFunctionPlugin(plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:455 (opens new window)

Registers all functions in a given plugin with optional translations.

Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used. HyperFormula instances created prior to the registration of a FunctionPlugin are unable to access the FunctionPlugin. Registering a FunctionPlugin with [[custom-functions]] requires the translations parameter.

throws [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register the plugin
 HyperFormula.registerFunctionPlugin(MyExamplePlugin);
-

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage optional package of function names translations

Returns: void

# registerLanguage Static

▸ registerLanguage(languageCode: string, languagePackage: RawTranslationPackage): void

Defined in src/HyperFormula.ts:379 (opens new window)

Registers language under given code string.

For more information, see the Localizing functions guide.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

throws [[LanguageAlreadyRegisteredError]] when given language is already registered

example

// return registered language
+

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage optional package of function names translations

Returns: void

# registerLanguage Static

▸ registerLanguage(languageCode: string, languagePackage: RawTranslationPackage): void

Defined in src/HyperFormula.ts:379 (opens new window)

Registers language under given code string.

For more information, see the Localizing functions guide.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

throws [[LanguageAlreadyRegisteredError]] when given language is already registered

example

// return registered language
 HyperFormula.registerLanguage('enUS', enUS);
 const engine = HyperFormula.buildEmpty({language: 'enUS'});
-

Parameters:

Name Type Description
languageCode string code string of the translation package
languagePackage RawTranslationPackage translation package to be registered

Returns: void

# unregisterAllFunctions Static

▸ unregisterAllFunctions(): void

Defined in src/HyperFormula.ts:550 (opens new window)

Clears function registry.

Note: This method does not affect the existing HyperFormula instances.

example

HyperFormula.unregisterAllFunctions();
-

Returns: void

# unregisterFunction Static

▸ unregisterFunction(functionId: string): void

Defined in src/HyperFormula.ts:533 (opens new window)

Unregisters a function with a given id.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Parameters:

Name Type Description
languageCode string code string of the translation package
languagePackage RawTranslationPackage translation package to be registered

Returns: void

# unregisterAllFunctions Static

▸ unregisterAllFunctions(): void

Defined in src/HyperFormula.ts:550 (opens new window)

Clears function registry.

Note: This method does not affect the existing HyperFormula instances.

example

HyperFormula.unregisterAllFunctions();
+

Returns: void

# unregisterFunction Static

▸ unregisterFunction(functionId: string): void

Defined in src/HyperFormula.ts:533 (opens new window)

Unregisters a function with a given id.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a function
@@ -1257,12 +1257,12 @@
 
 // unregister a function
 HyperFormula.unregisterFunction('EXAMPLE');
-

Parameters:

Name Type Description
functionId string function id, e.g., 'SUMIF'

Returns: void

# unregisterFunctionPlugin Static

▸ unregisterFunctionPlugin(plugin: FunctionPluginDefinition): void

Defined in src/HyperFormula.ts:477 (opens new window)

Unregisters all functions defined in given plugin.

Note: This method does not affect the existing HyperFormula instances.

example

// get the class of a plugin
+

Parameters:

Name Type Description
functionId string function id, e.g., 'SUMIF'

Returns: void

# unregisterFunctionPlugin Static

▸ unregisterFunctionPlugin(plugin: FunctionPluginDefinition): void

Defined in src/HyperFormula.ts:477 (opens new window)

Unregisters all functions defined in given plugin.

Note: This method does not affect the existing HyperFormula instances.

example

// get the class of a plugin
 const registeredPluginClass = HyperFormula.getFunctionPlugin('EXAMPLE');
 
 // unregister all functions defined in a plugin of ID 'EXAMPLE'
 HyperFormula.unregisterFunctionPlugin(registeredPluginClass);
-

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class

Returns: void

# unregisterLanguage Static

▸ unregisterLanguage(languageCode: string): void

Defined in src/HyperFormula.ts:407 (opens new window)

Unregisters language that is registered under given code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when given language is not registered

example

// register the language for the instance
+

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class

Returns: void

# unregisterLanguage Static

▸ unregisterLanguage(languageCode: string): void

Defined in src/HyperFormula.ts:407 (opens new window)

Unregisters language that is registered under given code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when given language is not registered

example

// register the language for the instance
 HyperFormula.registerLanguage('plPL', plPL);
 
 // unregister plPL
@@ -1276,6 +1276,6 @@
       
       →
- + \ No newline at end of file diff --git a/api/enums/events.html b/api/enums/events.html index f6a258fb3..4ea055f23 100644 --- a/api/enums/events.html +++ b/api/enums/events.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Events Enumeration

# Enumeration members

# EvaluationResumed

• EvaluationResumed: = "evaluationResumed"

Defined in src/Emitter.ts:17 (opens new window)

# EvaluationSuspended

• EvaluationSuspended: = "evaluationSuspended"

Defined in src/Emitter.ts:16 (opens new window)

# NamedExpressionAdded

• NamedExpressionAdded: = "namedExpressionAdded"

Defined in src/Emitter.ts:13 (opens new window)

# NamedExpressionRemoved

• NamedExpressionRemoved: = "namedExpressionRemoved"

Defined in src/Emitter.ts:14 (opens new window)

# SheetAdded

• SheetAdded: = "sheetAdded"

Defined in src/Emitter.ts:10 (opens new window)

# SheetRemoved

• SheetRemoved: = "sheetRemoved"

Defined in src/Emitter.ts:11 (opens new window)

# SheetRenamed

• SheetRenamed: = "sheetRenamed"

Defined in src/Emitter.ts:12 (opens new window)

# ValuesUpdated

• ValuesUpdated: = "valuesUpdated"

Defined in src/Emitter.ts:15 (opens new window)

- + (opens new window)

# Events Enumeration

# Enumeration members

# EvaluationResumed

• EvaluationResumed: = "evaluationResumed"

Defined in src/Emitter.ts:17 (opens new window)

# EvaluationSuspended

• EvaluationSuspended: = "evaluationSuspended"

Defined in src/Emitter.ts:16 (opens new window)

# NamedExpressionAdded

• NamedExpressionAdded: = "namedExpressionAdded"

Defined in src/Emitter.ts:13 (opens new window)

# NamedExpressionRemoved

• NamedExpressionRemoved: = "namedExpressionRemoved"

Defined in src/Emitter.ts:14 (opens new window)

# SheetAdded

• SheetAdded: = "sheetAdded"

Defined in src/Emitter.ts:10 (opens new window)

# SheetRemoved

• SheetRemoved: = "sheetRemoved"

Defined in src/Emitter.ts:11 (opens new window)

# SheetRenamed

• SheetRenamed: = "sheetRenamed"

Defined in src/Emitter.ts:12 (opens new window)

# ValuesUpdated

• ValuesUpdated: = "valuesUpdated"

Defined in src/Emitter.ts:15 (opens new window)

+ \ No newline at end of file diff --git a/api/globals.html b/api/globals.html index 007a0bcd5..97c31c121 100644 --- a/api/globals.html +++ b/api/globals.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# API Reference Overview

# Type aliases

# ConfigParamsList

Ƭ ConfigParamsList: keyof ConfigParams

Defined in src/ConfigParams.ts:402 (opens new window)

- + (opens new window)

# API Reference Overview

# Type aliases

# ConfigParamsList

Ƭ ConfigParamsList: keyof ConfigParams

Defined in src/ConfigParams.ts:402 (opens new window)

+ \ No newline at end of file diff --git a/api/index.html b/api/index.html index 37e08d5d5..831422213 100644 --- a/api/index.html +++ b/api/index.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# API Reference Overview

Welcome to the HyperFormula v2.7.0 API!

The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.

Current build: 10/04/2024 13:38:59

# API reference index

The following sections explain shortly what can be found in the left sidebar navigation menu.

# HyperFormula

This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.

The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:

const sheetData = [
+     (opens new window)    
 
# API Reference Overview
 
Welcome to the HyperFormula v2.7.0 API!
 
The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.
 
Current build: 20/06/2024 10:19:30
 
# API reference index
 
The following sections explain shortly what can be found in the left sidebar navigation menu.
 
# HyperFormula
 
This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.
 
The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:
 
const sheetData = [
   ['0', '=SUM(1, 2, 3)', '52'],
   ['=SUM(A1:C1)', '', '=A1'],
   ['2', '=SUM(A1:C1)', '91'],
@@ -81,6 +81,6 @@
       
       →
- + \ No newline at end of file diff --git a/api/interfaces/configparams.html b/api/interfaces/configparams.html index bf7f71a73..c54c00315 100644 --- a/api/interfaces/configparams.html +++ b/api/interfaces/configparams.html @@ -35,7 +35,7 @@ - + @@ -54,12 +54,12 @@ API Reference GitHub - (opens new window)

# ConfigParams Interface

# License

# licenseKey

• licenseKey: string

Defined in src/ConfigParams.ts:175 (opens new window)

Sets your HyperFormula license key.

To use HyperFormula on the GPLv3 license terms, set this option to gpl-v3.

To use HyperFormula with your commercial license, set this option to your valid license key string.

For more information, go here.

default undefined

# Engine

# binarySearchThreshold

• binarySearchThreshold: number

Defined in src/ConfigParams.ts:25 (opens new window)

Sets a minimum number of elements that a range must have to use binary search.

deprecated Every search of sorted data always uses binary search.

default 20

# chooseAddressMappingPolicy

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in src/ConfigParams.ts:54 (opens new window)

Sets the address mapping policy to be used.

Built-in implementations:

  • DenseSparseChooseBasedOnThreshold: sets the address mapping policy separately for each sheet, based on fill ratio.
  • AlwaysDense: uses DenseStrategy for all sheets.
  • AlwaysSparse: uses SparseStrategy for all sheets.

default AlwaysDense

# context

• context: unknown

Defined in src/ConfigParams.ts:60 (opens new window)

A generic parameter that can be used to pass data to custom functions.

default undefined

# evaluateNullToZero

• evaluateNullToZero: boolean

Defined in src/ConfigParams.ts:122 (opens new window)

When set to true, formulas evaluating to null evaluate to 0 instead.

default false

# maxColumns

• maxColumns: number

Defined in src/ConfigParams.ts:217 (opens new window)

Sets the maximum number of columns.

default 18.278 (Columns A, B, ..., ZZZ)

# maxRows

• maxRows: number

Defined in src/ConfigParams.ts:211 (opens new window)

Sets the maximum number of rows.

default 40.000

# useArrayArithmetic

• useArrayArithmetic: boolean

Defined in src/ConfigParams.ts:363 (opens new window)

When set to true, array arithmetic is enabled globally.

When set to false, array arithmetic is enabled only inside array functions (ARRAYFORMULA, FILTER, and ARRAY_CONSTRAIN).

For more information, see the Arrays guide.

default false

# useColumnIndex

• useColumnIndex: boolean

Defined in src/ConfigParams.ts:373 (opens new window)

When set to true, switches column search strategy from binary search to column index.

Using column index improves efficiency of the VLOOKUP and MATCH functions, but increases memory usage.

When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with useColumnIndex set to true).

default false

# useStats

• useStats: boolean

Defined in src/ConfigParams.ts:381 (opens new window)

When set to true, enables gathering engine statistics and timings.

Useful for testing and benchmarking.

default false

# Formula Syntax

# arrayColumnSeparator

• arrayColumnSeparator: "," | ";"

Defined in src/ConfigParams.ts:199 (opens new window)

Sets a column separator symbol for array notation.

default ','

# arrayRowSeparator

• arrayRowSeparator: ";" | "|"

Defined in src/ConfigParams.ts:205 (opens new window)

Sets a row separator symbol for array notation.

default ';'

# functionArgSeparator

• functionArgSeparator: string

Defined in src/ConfigParams.ts:102 (opens new window)

Sets a separator character that separates procedure arguments in formulas.

Must be different from decimalSeparator and thousandSeparator.

For more information, see the Internationalization features guide.

default ','

# functionPlugins

• functionPlugins: any[]

Defined in src/ConfigParams.ts:129 (opens new window)

Lists additional function plugins to be used by the formula interpreter.

default []

# ignoreWhiteSpace

• ignoreWhiteSpace: "standard" | "any"

Defined in src/ConfigParams.ts:153 (opens new window)

Controls the set of whitespace characters that are allowed inside a formula.

When set to 'standard', allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)

When set to 'any', allows all whitespace characters that would be captured by the \s character class of the JavaScript regular expressions.

default 'standard'

# language

• language: string

Defined in src/ConfigParams.ts:143 (opens new window)

Sets a translation package for function and error names.

For more information, see the Localizing functions guide.

default 'enGB'

# Undo and Redo

# undoLimit

• undoLimit: number

Defined in src/ConfigParams.ts:387 (opens new window)

Sets the number of elements kept in the undo history.

default 20

# Date and Time

# dateFormats

• dateFormats: string[]

Defined in src/ConfigParams.ts:92 (opens new window)

Sets the date formats accepted by the date-parsing function.

A format must be specified as a string consisting of tokens and separators.

Supported tokens:

  • DD (day of month)
  • MM (month as a number)
  • YYYY (year as a 4-digit number)
  • YY (year as a 2-digit number)

Supported separators:

  • / (slash)
  • - (dash)
  • . (dot)
  • (empty space)

Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.

For more information, see the Date and time handling guide.

default ['DD/MM/YYYY', 'DD/MM/YY']

# leapYear1900

• leapYear1900: boolean

Defined in src/ConfigParams.ts:163 (opens new window)

Sets year 1900 as a leap year.

For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to true.

For more information, see nullDate.

default false

# nullDate

• nullDate: SimpleDate

Defined in src/ConfigParams.ts:227 (opens new window)

Internally, each date is represented as a number of days that passed since nullDate.

This option sets a specific date from which that number of days is counted.

For more information, see the Date and time handling guide.

default {year: 1899, month: 12, day: 30}

# nullYear

• nullYear: number

Defined in src/ConfigParams.ts:239 (opens new window)

Sets the interpretation of two-digit year values.

Two-digit year values (xx) can either become 19xx or 20xx.

If xx is less or equal to nullYear, two-digit year values become 20xx.

If xx is more than nullYear, two-digit year values become 19xx.

default 30

# parseDateTime

• parseDateTime: function

Defined in src/ConfigParams.ts:249 (opens new window)

Sets a function that parses strings representing date-time into actual date-time values.

The function should return a DateTime object or undefined.

For more information, see the Date and time handling guide.

default defaultParseToDateTime

# Type declaration:

▸ (dateTimeString: string, dateFormat?: undefined | string, timeFormat?: undefined | string): Maybe‹DateTime›

Parameters:

Name Type
dateTimeString string
dateFormat? undefined | string
timeFormat? undefined | string

# stringifyDateTime

• stringifyDateTime: function

Defined in src/ConfigParams.ts:289 (opens new window)

Sets a function that converts date-time values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDateTime

# Type declaration:

▸ (dateTime: SimpleDateTime, dateTimeFormat: string): Maybe‹string›

Parameters:

Name Type
dateTime SimpleDateTime
dateTimeFormat string

# stringifyDuration

• stringifyDuration: function

Defined in src/ConfigParams.ts:299 (opens new window)

Sets a function that converts time duration values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDuration

# Type declaration:

▸ (time: SimpleTime, timeFormat: string): Maybe‹string›

Parameters:

Name Type
time SimpleTime
timeFormat string

# timeFormats

• timeFormats: string[]

Defined in src/ConfigParams.ts:353 (opens new window)

Sets the time formats accepted by the time-parsing function.

A format must be specified as a string consisting of at least two tokens separated by : (a colon).

Supported tokens:

  • hh (hours)
  • mm (minutes)
  • ss, ss.s, ss.ss, ss.sss, ss.ssss, etc. (seconds)

The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values. + (opens new window)

# ConfigParams Interface

# License

# licenseKey

• licenseKey: string

Defined in src/ConfigParams.ts:175 (opens new window)

Sets your HyperFormula license key.

To use HyperFormula on the GPLv3 license terms, set this option to gpl-v3.

To use HyperFormula with your commercial license, set this option to your valid license key string.

For more information, go here.

default undefined

# Engine

# binarySearchThreshold

• binarySearchThreshold: number

Defined in src/ConfigParams.ts:25 (opens new window)

Sets a minimum number of elements that a range must have to use binary search.

deprecated Every search of sorted data always uses binary search.

default 20

# chooseAddressMappingPolicy

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in src/ConfigParams.ts:54 (opens new window)

Sets the address mapping policy to be used.

Built-in implementations:

  • DenseSparseChooseBasedOnThreshold: sets the address mapping policy separately for each sheet, based on fill ratio.
  • AlwaysDense: uses DenseStrategy for all sheets.
  • AlwaysSparse: uses SparseStrategy for all sheets.

default AlwaysDense

# context

• context: unknown

Defined in src/ConfigParams.ts:60 (opens new window)

A generic parameter that can be used to pass data to custom functions.

default undefined

# evaluateNullToZero

• evaluateNullToZero: boolean

Defined in src/ConfigParams.ts:122 (opens new window)

When set to true, formulas evaluating to null evaluate to 0 instead.

default false

# maxColumns

• maxColumns: number

Defined in src/ConfigParams.ts:217 (opens new window)

Sets the maximum number of columns.

default 18.278 (Columns A, B, ..., ZZZ)

# maxRows

• maxRows: number

Defined in src/ConfigParams.ts:211 (opens new window)

Sets the maximum number of rows.

default 40.000

# useArrayArithmetic

• useArrayArithmetic: boolean

Defined in src/ConfigParams.ts:363 (opens new window)

When set to true, array arithmetic is enabled globally.

When set to false, array arithmetic is enabled only inside array functions (ARRAYFORMULA, FILTER, and ARRAY_CONSTRAIN).

For more information, see the Arrays guide.

default false

# useColumnIndex

• useColumnIndex: boolean

Defined in src/ConfigParams.ts:373 (opens new window)

When set to true, switches column search strategy from binary search to column index.

Using column index improves efficiency of the VLOOKUP and MATCH functions, but increases memory usage.

When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with useColumnIndex set to true).

default false

# useStats

• useStats: boolean

Defined in src/ConfigParams.ts:381 (opens new window)

When set to true, enables gathering engine statistics and timings.

Useful for testing and benchmarking.

default false

# Formula Syntax

# arrayColumnSeparator

• arrayColumnSeparator: "," | ";"

Defined in src/ConfigParams.ts:199 (opens new window)

Sets a column separator symbol for array notation.

default ','

# arrayRowSeparator

• arrayRowSeparator: ";" | "|"

Defined in src/ConfigParams.ts:205 (opens new window)

Sets a row separator symbol for array notation.

default ';'

# functionArgSeparator

• functionArgSeparator: string

Defined in src/ConfigParams.ts:102 (opens new window)

Sets a separator character that separates procedure arguments in formulas.

Must be different from decimalSeparator and thousandSeparator.

For more information, see the Internationalization features guide.

default ','

# functionPlugins

• functionPlugins: any[]

Defined in src/ConfigParams.ts:129 (opens new window)

Lists additional function plugins to be used by the formula interpreter.

default []

# ignoreWhiteSpace

• ignoreWhiteSpace: "standard" | "any"

Defined in src/ConfigParams.ts:153 (opens new window)

Controls the set of whitespace characters that are allowed inside a formula.

When set to 'standard', allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)

When set to 'any', allows all whitespace characters that would be captured by the \s character class of the JavaScript regular expressions.

default 'standard'

# language

• language: string

Defined in src/ConfigParams.ts:143 (opens new window)

Sets a translation package for function and error names.

For more information, see the Localizing functions guide.

default 'enGB'

# Undo and Redo

# undoLimit

• undoLimit: number

Defined in src/ConfigParams.ts:387 (opens new window)

Sets the number of elements kept in the undo history.

default 20

# Date and Time

# dateFormats

• dateFormats: string[]

Defined in src/ConfigParams.ts:92 (opens new window)

Sets the date formats accepted by the date-parsing function.

A format must be specified as a string consisting of tokens and separators.

Supported tokens:

  • DD (day of month)
  • MM (month as a number)
  • YYYY (year as a 4-digit number)
  • YY (year as a 2-digit number)

Supported separators:

  • / (slash)
  • - (dash)
  • . (dot)
  • (empty space)

Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.

For more information, see the Date and time handling guide.

default ['DD/MM/YYYY', 'DD/MM/YY']

# leapYear1900

• leapYear1900: boolean

Defined in src/ConfigParams.ts:163 (opens new window)

Sets year 1900 as a leap year.

For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to true.

For more information, see nullDate.

default false

# nullDate

• nullDate: SimpleDate

Defined in src/ConfigParams.ts:227 (opens new window)

Internally, each date is represented as a number of days that passed since nullDate.

This option sets a specific date from which that number of days is counted.

For more information, see the Date and time handling guide.

default {year: 1899, month: 12, day: 30}

# nullYear

• nullYear: number

Defined in src/ConfigParams.ts:239 (opens new window)

Sets the interpretation of two-digit year values.

Two-digit year values (xx) can either become 19xx or 20xx.

If xx is less or equal to nullYear, two-digit year values become 20xx.

If xx is more than nullYear, two-digit year values become 19xx.

default 30

# parseDateTime

• parseDateTime: function

Defined in src/ConfigParams.ts:249 (opens new window)

Sets a function that parses strings representing date-time into actual date-time values.

The function should return a DateTime object or undefined.

For more information, see the Date and time handling guide.

default defaultParseToDateTime

# Type declaration:

▸ (dateTimeString: string, dateFormat?: undefined | string, timeFormat?: undefined | string): Maybe‹DateTime›

Parameters:

Name Type
dateTimeString string
dateFormat? undefined | string
timeFormat? undefined | string

# stringifyDateTime

• stringifyDateTime: function

Defined in src/ConfigParams.ts:289 (opens new window)

Sets a function that converts date-time values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDateTime

# Type declaration:

▸ (dateTime: SimpleDateTime, dateTimeFormat: string): Maybe‹string›

Parameters:

Name Type
dateTime SimpleDateTime
dateTimeFormat string

# stringifyDuration

• stringifyDuration: function

Defined in src/ConfigParams.ts:299 (opens new window)

Sets a function that converts time duration values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDuration

# Type declaration:

▸ (time: SimpleTime, timeFormat: string): Maybe‹string›

Parameters:

Name Type
time SimpleTime
timeFormat string

# timeFormats

• timeFormats: string[]

Defined in src/ConfigParams.ts:353 (opens new window)

Sets the time formats accepted by the time-parsing function.

A format must be specified as a string consisting of at least two tokens separated by : (a colon).

Supported tokens:

  • hh (hours)
  • mm (minutes)
  • ss, ss.s, ss.ss, ss.sss, ss.ssss, etc. (seconds)

The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values. Regardless of the time format specified, the hours-minutes-seconds value may be followed by the AM/PM designator.

For more information, see the Date and time handling guide.

example -E.g., for timeFormats = ['hh:mm:ss.sss'], valid time strings include:

  • 1:33:33
  • 1:33:33.3
  • 1:33:33.33
  • 1:33:33.333
  • 01:33:33
  • 1:33:33 AM
  • 1:33:33 PM
  • 1:33:33 am
  • 1:33:33 pm
  • 1:33:33AM
  • 1:33:33PM

default ['hh:mm', 'hh:mm:ss.sss']

# Number

# currencySymbol

• currencySymbol: string[]

Defined in src/ConfigParams.ts:68 (opens new window)

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default ['$']

# decimalSeparator

• decimalSeparator: "." | ","

Defined in src/ConfigParams.ts:116 (opens new window)

Sets a decimal separator used for parsing numerical literals.

Can be one of the following:

  • . (period)
  • , (comma)

Must be different from thousandSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default '.'

# precisionEpsilon

• precisionEpsilon: number

Defined in src/ConfigParams.ts:264 (opens new window)

Sets how far two numerical values need to be from each other to be treated as non-equal.

a and b are equal if all three of the following conditions are met:

  • Both a and b are of the same sign
  • abs(a) <= (1+precisionEpsilon) * abs(b)
  • abs(b) <= (1+precisionEpsilon) * abs(a)

Additionally, this option controls the snap-to-zero behavior for additions and subtractions:

  • For c=a+b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0
  • For c=a-b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0

default 1e-13

# precisionRounding

• precisionRounding: number

Defined in src/ConfigParams.ts:279 (opens new window)

Sets the precision level of calculations' output.

Internally, all arithmetic operations are performed using JavaScript's built-in numbers. +E.g., for timeFormats = ['hh:mm:ss.sss'], valid time strings include:

  • 1:33:33
  • 1:33:33.3
  • 1:33:33.33
  • 1:33:33.333
  • 01:33:33
  • 1:33:33 AM
  • 1:33:33 PM
  • 1:33:33 am
  • 1:33:33 pm
  • 1:33:33AM
  • 1:33:33PM

default ['hh:mm', 'hh:mm:ss.sss']

# Number

# currencySymbol

• currencySymbol: string[]

Defined in src/ConfigParams.ts:68 (opens new window)

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default ['$']

# decimalSeparator

• decimalSeparator: "." | ","

Defined in src/ConfigParams.ts:116 (opens new window)

Sets a decimal separator used for parsing numerical literals.

Can be one of the following:

  • . (period)
  • , (comma)

Must be different from thousandSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default '.'

# precisionEpsilon

• precisionEpsilon: number

Defined in src/ConfigParams.ts:264 (opens new window)

Sets how far two numerical values need to be from each other to be treated as non-equal.

a and b are equal if all three of the following conditions are met:

  • Both a and b are of the same sign
  • abs(a) <= (1+precisionEpsilon) * abs(b)
  • abs(b) <= (1+precisionEpsilon) * abs(a)

Additionally, this option controls the snap-to-zero behavior for additions and subtractions:

  • For c=a+b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0
  • For c=a-b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0

default 1e-13

# precisionRounding

• precisionRounding: number

Defined in src/ConfigParams.ts:279 (opens new window)

Sets the precision level of calculations' output.

Internally, all arithmetic operations are performed using JavaScript's built-in numbers. But when HyperFormula exports a cell's value, it rounds the output to the precisionRounding number of significant digits.

Setting precisionRounding too low can cause large numbers' imprecision -(for example, with precisionRounding set to 4, 100005 becomes 100010).

We recommend setting precisionRounding to a value between 10 and 14.

default 14

# smartRounding

• smartRounding: boolean

Defined in src/ConfigParams.ts:307 (opens new window)

When set to false, no rounding happens, and numbers are equal if and only if they are of truly identical value.

For more information, see precisionEpsilon.

default true

# thousandSeparator

• thousandSeparator: "" | "," | " " | "."

Defined in src/ConfigParams.ts:322 (opens new window)

Sets the thousands' separator symbol for parsing numerical literals.

Can be one of the following:

  • empty
  • , (comma)
  • (empty space)

Must be different from decimalSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default ''

# String

# accentSensitive

• accentSensitive: boolean

Defined in src/ConfigParams.ts:18 (opens new window)

When set to true, makes string comparison accent-sensitive.

Applies only to comparison operators.

default false

# caseFirst

• caseFirst: "upper" | "lower" | "false"

Defined in src/ConfigParams.ts:43 (opens new window)

When set to upper, upper case sorts first.

When set to lower, lower case sorts first.

When set to false, uses the locale's default.

default 'lower'

# caseSensitive

• caseSensitive: boolean

Defined in src/ConfigParams.ts:33 (opens new window)

When set to true, makes string comparison case-sensitive.

Applies to comparison operators only.

default false

# ignorePunctuation

• ignorePunctuation: boolean

Defined in src/ConfigParams.ts:135 (opens new window)

When set to true, string comparison ignores punctuation.

default false

# localeLang

• localeLang: string

Defined in src/ConfigParams.ts:185 (opens new window)

Sets the locale for language-sensitive string comparison.

Accepts IETF BCP 47 language tags.

For more information, see the Internationalization features guide.

default 'en'

# matchWholeCell

• matchWholeCell: boolean

Defined in src/ConfigParams.ts:193 (opens new window)

When set to true, function criteria require whole cells to match the pattern.

When set to false, function criteria require just a sub-word to match the pattern.

default true

# useRegularExpressions

• useRegularExpressions: boolean

Defined in src/ConfigParams.ts:393 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.

default false

# useWildcards

• useWildcards: boolean

Defined in src/ConfigParams.ts:399 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) can use the * and ? wildcards.

default true

+(for example, with precisionRounding set to 4, 100005 becomes 100010).

We recommend setting precisionRounding to a value between 10 and 14.

default 14

# smartRounding

• smartRounding: boolean

Defined in src/ConfigParams.ts:307 (opens new window)

When set to false, no rounding happens, and numbers are equal if and only if they are of truly identical value.

For more information, see precisionEpsilon.

default true

# thousandSeparator

• thousandSeparator: "" | "," | " " | "."

Defined in src/ConfigParams.ts:322 (opens new window)

Sets the thousands' separator symbol for parsing numerical literals.

Can be one of the following:

  • empty
  • , (comma)
  • (empty space)

Must be different from decimalSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default ''

# String

# accentSensitive

• accentSensitive: boolean

Defined in src/ConfigParams.ts:18 (opens new window)

When set to true, makes string comparison accent-sensitive.

Applies only to comparison operators.

default false

# caseFirst

• caseFirst: "upper" | "lower" | "false"

Defined in src/ConfigParams.ts:43 (opens new window)

When set to upper, upper case sorts first.

When set to lower, lower case sorts first.

When set to false, uses the locale's default.

default 'lower'

# caseSensitive

• caseSensitive: boolean

Defined in src/ConfigParams.ts:33 (opens new window)

When set to true, makes string comparison case-sensitive.

Applies to comparison operators only.

default false

# ignorePunctuation

• ignorePunctuation: boolean

Defined in src/ConfigParams.ts:135 (opens new window)

When set to true, string comparison ignores punctuation.

default false

# localeLang

• localeLang: string

Defined in src/ConfigParams.ts:185 (opens new window)

Sets the locale for language-sensitive string comparison.

Accepts IETF BCP 47 language tags.

For more information, see the Internationalization features guide.

default 'en'

# matchWholeCell

• matchWholeCell: boolean

Defined in src/ConfigParams.ts:193 (opens new window)

When set to true, function criteria require whole cells to match the pattern.

When set to false, function criteria require just a sub-word to match the pattern.

default true

# useRegularExpressions

• useRegularExpressions: boolean

Defined in src/ConfigParams.ts:393 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.

default false

# useWildcards

• useWildcards: boolean

Defined in src/ConfigParams.ts:399 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) can use the * and ? wildcards.

default true

← →

- + \ No newline at end of file diff --git a/api/interfaces/listeners.html b/api/interfaces/listeners.html index 1e9a13976..972f0ee49 100644 --- a/api/interfaces/listeners.html +++ b/api/interfaces/listeners.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Listeners Interface

# Batch

# evaluationResumed

• evaluationResumed: function

Defined in src/Emitter.ts:316 (opens new window)

Occurs when evaluation is resumed.

param the values and location of applied changes

example

const hfInstance = HyperFormula.buildFromSheets({
+     (opens new window)    
 
# Listeners Interface
 
# Batch
 
# evaluationResumed
 
• evaluationResumed: function
 
Defined in src/Emitter.ts:316 (opens new window)
 
Occurs when evaluation is resumed.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ]
 });
@@ -81,7 +81,7 @@
 // resume evaluation again
 // this time, the console doesn't print anything
 hfInstance.resumeEvaluation();;
-
# Type declaration:
 
▸ (changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
changes ExportedChange[]
 
 
# evaluationSuspended
 
• evaluationSuspended: function
 
Defined in src/Emitter.ts:274 (opens new window)
 
Occurs when evaluation is suspended.
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
changes ExportedChange[]
 
 
# evaluationSuspended
 
• evaluationSuspended: function
 
Defined in src/Emitter.ts:274 (opens new window)
 
Occurs when evaluation is suspended.
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ]
 });
@@ -105,7 +105,7 @@
 // suspend evaluation again
 // this time, the console doesn't print anything
 hfInstance.suspendEvaluation();;
-
# Type declaration:
 
▸ (): any
 
 
# Named Expression
 
# namedExpressionAdded
 
• namedExpressionAdded: function
 
Defined in src/Emitter.ts:162 (opens new window)
 
Occurs when a named expression with specified values and location is added.
 
param the name of added expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (): any
 
 
# Named Expression
 
# namedExpressionAdded
 
• namedExpressionAdded: function
 
Defined in src/Emitter.ts:162 (opens new window)
 
Occurs when a named expression with specified values and location is added.
 
param the name of added expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['42'],
 ]);
 
@@ -125,7 +125,7 @@
 // add another named expression
 // this time, the console doesn't print anything
 const changes = hfInstance.addNamedExpression('uglyName', '=Sheet1!$A$1+100', 0);
-
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# namedExpressionRemoved
 
• namedExpressionRemoved: function
 
Defined in src/Emitter.ts:202 (opens new window)
 
Occurs when a named expression with specified values is removed and from an indicated location.
 
param the name of removed expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# namedExpressionRemoved
 
• namedExpressionRemoved: function
 
Defined in src/Emitter.ts:202 (opens new window)
 
Occurs when a named expression with specified values is removed and from an indicated location.
 
param the name of removed expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['42'],
 ]);
 
@@ -149,7 +149,7 @@
 // remove another named expression
 // this time, the console doesn't print anything
 const changes = hfInstance.removeNamedExpression('uglyName', 0);
-
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# Sheet
 
# sheetAdded
 
• sheetAdded: function
 
Defined in src/Emitter.ts:52 (opens new window)
 
Occurs when a sheet is added anywhere inside the workbook.
 
param the name of added sheet
 
example
 
const hfInstance = HyperFormula.buildEmpty();
+
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# Sheet
 
# sheetAdded
 
• sheetAdded: function
 
Defined in src/Emitter.ts:52 (opens new window)
 
Occurs when a sheet is added anywhere inside the workbook.
 
param the name of added sheet
 
example
 
const hfInstance = HyperFormula.buildEmpty();
 
 // define a function to be called when the event occurs
 const handler = (addedSheetDisplayName) => { console.log('baz') }
@@ -167,7 +167,7 @@
 // add a sheet
 // this time, the console doesn't print anything
 hfInstance.addSheet('FooBaz');
-
# Type declaration:
 
▸ (addedSheetDisplayName: string): any
 
Parameters:
 
Name Type
 
addedSheetDisplayName string
 
 
# sheetRemoved
 
• sheetRemoved: function
 
Defined in src/Emitter.ts:89 (opens new window)
 
Occurs when a sheet is removed from anywhere inside the workbook.
 
param the name of removed sheet
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (addedSheetDisplayName: string): any
 
Parameters:
 
Name Type
 
addedSheetDisplayName string
 
 
# sheetRemoved
 
• sheetRemoved: function
 
Defined in src/Emitter.ts:89 (opens new window)
 
Occurs when a sheet is removed from anywhere inside the workbook.
 
param the name of removed sheet
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
   MySheet2: [ ['10'] ],
 });
@@ -188,7 +188,7 @@
 // remove a sheet
 // this time, the console doesn't print anything
 hfInstance.removeSheet(1);
-
# Type declaration:
 
▸ (removedSheetDisplayName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
removedSheetDisplayName string
 
changes ExportedChange[]
 
 
# sheetRenamed
 
• sheetRenamed: function
 
Defined in src/Emitter.ts:126 (opens new window)
 
Occurs when a sheet is renamed anywhere inside the workbook.
 
param the old name of a sheet before renaming
 
param the new name of the sheet after renaming
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (removedSheetDisplayName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
removedSheetDisplayName string
 
changes ExportedChange[]
 
 
# sheetRenamed
 
• sheetRenamed: function
 
Defined in src/Emitter.ts:126 (opens new window)
 
Occurs when a sheet is renamed anywhere inside the workbook.
 
param the old name of a sheet before renaming
 
param the new name of the sheet after renaming
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
   MySheet2: [ ['10'] ],
 });
@@ -209,7 +209,7 @@
 // rename a sheet
 // this time, the console doesn't print anything
 hfInstance.renameSheet(1, 'MySheet1');
-
# Type declaration:
 
▸ (oldDisplayName: string, newDisplayName: string): any
 
Parameters:
 
Name Type
 
oldDisplayName string
 
newDisplayName string
 
 
# Values
 
# valuesUpdated
 
• valuesUpdated: function
 
Defined in src/Emitter.ts:237 (opens new window)
 
Occurs when values in a specified location are changed and cause recalculation.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (oldDisplayName: string, newDisplayName: string): any
 
Parameters:
 
Name Type
 
oldDisplayName string
 
newDisplayName string
 
 
# Values
 
# valuesUpdated
 
• valuesUpdated: function
 
Defined in src/Emitter.ts:237 (opens new window)
 
Occurs when values in a specified location are changed and cause recalculation.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '=A1'],
 ]);
 
@@ -234,6 +234,6 @@
- + \ No newline at end of file diff --git a/api/interfaces/typedemitter.html b/api/interfaces/typedemitter.html index 775dbd9fd..4b6254f17 100644 --- a/api/interfaces/typedemitter.html +++ b/api/interfaces/typedemitter.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# TypedEmitter Interface

# Methods

# off

▸ off‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:322 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# on

▸ on‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:320 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# once

▸ once‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:324 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

- + (opens new window)

# TypedEmitter Interface

# Methods

# off

▸ off‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:322 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# on

▸ on‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:320 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# once

▸ once‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:324 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

+ \ No newline at end of file diff --git a/assets/js/20.028dc2b5.js b/assets/js/20.d1175753.js similarity index 99% rename from assets/js/20.028dc2b5.js rename to assets/js/20.d1175753.js index 395840781..0d80fa7ee 100644 --- a/assets/js/20.028dc2b5.js +++ b/assets/js/20.d1175753.js @@ -676,7 +676,7 @@ * . * * Version: 2.7.0 - * Release date: 10/04/2024 (built at 10/04/2024 13:38:59) + * Release date: 10/04/2024 (built at 20/06/2024 10:19:30) */ var n;r(96),r(89),r(91),r(298),r(299),r(301),"undefined"!=typeof self&&self,n=function(){return function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}return r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=0)}([function(e,t,r){"use strict";t.__esModule=!0,t.default=void 0;var n=r(1);t.ArraySize=n.ArraySize;var o=r(73);t.CellError=o.CellError,t.CellType=o.CellType,t.CellValueDetailedType=o.CellValueDetailedType,t.CellValueType=o.CellValueType,t.ErrorType=o.ErrorType;var s=r(170);t.DetailedCellError=s.DetailedCellError;var i=r(171),a=r(175);t.AlwaysDense=a.AlwaysDense,t.AlwaysSparse=a.AlwaysSparse,t.DenseSparseChooseBasedOnThreshold=a.DenseSparseChooseBasedOnThreshold;var u=r(147);t.ConfigValueTooBigError=u.ConfigValueTooBigError,t.ConfigValueTooSmallError=u.ConfigValueTooSmallError,t.EvaluationSuspendedError=u.EvaluationSuspendedError,t.ExpectedOneOfValuesError=u.ExpectedOneOfValuesError,t.ExpectedValueOfTypeError=u.ExpectedValueOfTypeError,t.FunctionPluginValidationError=u.FunctionPluginValidationError,t.InvalidAddressError=u.InvalidAddressError,t.InvalidArgumentsError=u.InvalidArgumentsError,t.LanguageAlreadyRegisteredError=u.LanguageAlreadyRegisteredError,t.LanguageNotRegisteredError=u.LanguageNotRegisteredError,t.MissingTranslationError=u.MissingTranslationError,t.NamedExpressionDoesNotExistError=u.NamedExpressionDoesNotExistError,t.NamedExpressionNameIsAlreadyTakenError=u.NamedExpressionNameIsAlreadyTakenError,t.NamedExpressionNameIsInvalidError=u.NamedExpressionNameIsInvalidError,t.NoOperationToRedoError=u.NoOperationToRedoError,t.NoOperationToUndoError=u.NoOperationToUndoError,t.NoRelativeAddressesAllowedError=u.NoRelativeAddressesAllowedError,t.NoSheetWithIdError=u.NoSheetWithIdError,t.NoSheetWithNameError=u.NoSheetWithNameError,t.NotAFormulaError=u.NotAFormulaError,t.NothingToPasteError=u.NothingToPasteError,t.ProtectedFunctionTranslationError=u.ProtectedFunctionTranslationError,t.SheetNameAlreadyTakenError=u.SheetNameAlreadyTakenError,t.SheetSizeLimitExceededError=u.SheetSizeLimitExceededError,t.SourceLocationHasArrayError=u.SourceLocationHasArrayError,t.TargetLocationHasArrayError=u.TargetLocationHasArrayError,t.UnableToParseError=u.UnableToParseError;var c=r(198);t.ExportedCellChange=c.ExportedCellChange,t.ExportedNamedExpressionChange=c.ExportedNamedExpressionChange;var l=r(180);t.HyperFormula=l.HyperFormula;var h,d=(h=r(216))&&h.__esModule?h:{default:h},p=r(166);t.FunctionPlugin=p.FunctionPlugin,t.FunctionArgumentType=p.FunctionArgumentType,t.EmptyValue=p.EmptyValue;var m=function(e,t){if(!t&&e&&e.__esModule)return e;if(null===e||"object"!=typeof e&&"function"!=typeof e)return{default:e};var r=f(t);if(r&&r.has(e))return r.get(e);var n={__proto__:null},o=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var s in e)if("default"!==s&&{}.hasOwnProperty.call(e,s)){var i=o?Object.getOwnPropertyDescriptor(e,s):null;i&&(i.get||i.set)?Object.defineProperty(n,s,i):n[s]=e[s]}return n.default=e,r&&r.set(e,n),n}(r(217)),g=r(139);function f(e){if("function"!=typeof WeakMap)return null;var t=new WeakMap,r=new WeakMap;return(f=function(e){return e?r:t})(e)}t.SimpleRangeValue=g.SimpleRangeValue; /** @@ -941,7 +941,7 @@ const n=/(\\.|dd|DD|d|D|mm|MM|m|M|YYYY|YY|yyyy|yy|HH|hh|H|h|ss(\.(0+|s+))?|s|AM\ * @license * Copyright (c) 2024 Handsoncode. All rights reserved. */ -class E{constructor(e,t,r,n,o,s,i,a,u,c,l,d,p,m){this._config=e,this._stats=t,this._dependencyGraph=r,this._columnSearch=n,this._parser=o,this._unparser=s,this._cellContentParser=i,this._evaluator=a,this._lazilyTransformingAstService=u,this._crudOperations=c,this._exporter=l,this._namedExpressions=d,this._serialization=p,this._functionRegistry=m,this._emitter=new h.Emitter,this._evaluationSuspended=!1}static get defaultConfig(){return(0,u.getDefaultConfig)()}get graph(){return this.dependencyGraph.graph}get rangeMapping(){return this.dependencyGraph.rangeMapping}get arrayMapping(){return this.dependencyGraph.arrayMapping}get sheetMapping(){return this.dependencyGraph.sheetMapping}get addressMapping(){return this.dependencyGraph.addressMapping}get dependencyGraph(){return this._dependencyGraph}get evaluator(){return this._evaluator}get columnSearch(){return this._columnSearch}get lazilyTransformingAstService(){return this._lazilyTransformingAstService}get licenseKeyValidityState(){return this._config.licenseKeyValidityState}static buildFromArray(e,t={},r=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildFromSheet(e,t,r))}static buildFromSheets(e,t={},r=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildFromSheets(e,t,r))}static buildEmpty(e={},t=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildEmpty(e,t))}static getLanguage(e){(0,o.validateArgToType)(e,"string","languageCode");const t=this.registeredLanguages.get(e);if(void 0===t)throw new d.LanguageNotRegisteredError;return t}static registerLanguage(e,t){if((0,o.validateArgToType)(e,"string","languageCode"),this.registeredLanguages.has(e))throw new d.LanguageAlreadyRegisteredError;this.registeredLanguages.set(e,(0,p.buildTranslationPackage)(t))}static unregisterLanguage(e){if((0,o.validateArgToType)(e,"string","languageCode"),!this.registeredLanguages.has(e))throw new d.LanguageNotRegisteredError;this.registeredLanguages.delete(e)}static getRegisteredLanguagesCodes(){return Array.from(this.registeredLanguages.keys())}static registerFunctionPlugin(e,t){m.FunctionRegistry.registerFunctionPlugin(e,t)}static unregisterFunctionPlugin(e){m.FunctionRegistry.unregisterFunctionPlugin(e)}static registerFunction(e,t,r){(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.registerFunction(e,t,r)}static unregisterFunction(e){(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.unregisterFunction(e)}static unregisterAllFunctions(){m.FunctionRegistry.unregisterAll()}static getRegisteredFunctionNames(e){(0,o.validateArgToType)(e,"string","code");const t=m.FunctionRegistry.getRegisteredFunctionIds();return this.getLanguage(e).getFunctionTranslations(t)}static getFunctionPlugin(e){return(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.getFunctionPlugin(e)}static getAllFunctionPlugins(){return m.FunctionRegistry.getPlugins()}static buildFromEngineState(e){return new E(e.config,e.stats,e.dependencyGraph,e.columnSearch,e.parser,e.unparser,e.cellContentParser,e.evaluator,e.lazilyTransformingAstService,e.crudOperations,e.exporter,e.namedExpressions,e.serialization,e.functionRegistry)}getCellValue(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellValue(e)}getCellFormula(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this._serialization.getCellFormula(e)}getCellHyperlink(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellHyperlink(e)}getCellSerialized(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellSerialized(e)}getSheetValues(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.ensureEvaluationIsNotSuspended(),this._serialization.getSheetValues(e)}getSheetFormulas(e){return(0,o.validateArgToType)(e,"number","sheetId"),this._serialization.getSheetFormulas(e)}getSheetSerialized(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.ensureEvaluationIsNotSuspended(),this._serialization.getSheetSerialized(e)}getAllSheetsDimensions(){return this._serialization.genericAllSheetsGetter(e=>this.getSheetDimensions(e))}getSheetDimensions(e){return(0,o.validateArgToType)(e,"number","sheetId"),{width:this.dependencyGraph.getSheetWidth(e),height:this.dependencyGraph.getSheetHeight(e)}}getAllSheetsValues(){return this.ensureEvaluationIsNotSuspended(),this._serialization.getAllSheetsValues()}getAllSheetsFormulas(){return this._serialization.getAllSheetsFormulas()}getAllSheetsSerialized(){return this.ensureEvaluationIsNotSuspended(),this._serialization.getAllSheetsSerialized()}updateConfig(e){Object.entries(e).every(([e,t])=>this._config[e]===t)||this.rebuildWithConfig(e)}getConfig(){return this._config.getConfig()}rebuildAndRecalculate(){this.rebuildWithConfig({})}getStats(){return this._stats.snapshot()}undo(){return this._crudOperations.undo(),this.recomputeIfDependencyGraphNeedsIt()}redo(){return this._crudOperations.redo(),this.recomputeIfDependencyGraphNeedsIt()}isThereSomethingToUndo(){return this._crudOperations.isThereSomethingToUndo()}isThereSomethingToRedo(){return this._crudOperations.isThereSomethingToRedo()}isItPossibleToSetCellContents(e){let t;if((0,i.isSimpleCellAddress)(e))t=new n.AbsoluteCellRange(e,e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange","address");t=new n.AbsoluteCellRange(e.start,e.end)}try{this._crudOperations.ensureRangeInSizeLimits(t);for(const e of t.addresses(this._dependencyGraph))this._crudOperations.ensureItIsPossibleToChangeContent(e)}catch(e){return!1}return!0}setCellContents(e,t){return this._crudOperations.setCellContents(e,t),this.recomputeIfDependencyGraphNeedsIt()}swapRowIndexes(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setRowOrder(e,t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToSwapRowIndexes(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.validateSwapRowIndexes(e,t),this._crudOperations.testRowOrderForArrays(e,t),!0}catch(e){return!1}}setRowOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");const r=this._crudOperations.mappingFromOrder(e,t,"row");return this.swapRowIndexes(e,r)}isItPossibleToSetRowOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{const r=this._crudOperations.mappingFromOrder(e,t,"row");return this._crudOperations.validateSwapRowIndexes(e,r),this._crudOperations.testRowOrderForArrays(e,r),!0}catch(e){return!1}}swapColumnIndexes(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setColumnOrder(e,t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToSwapColumnIndexes(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.validateSwapColumnIndexes(e,t),this._crudOperations.testColumnOrderForArrays(e,t),!0}catch(e){return!1}}setColumnOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");const r=this._crudOperations.mappingFromOrder(e,t,"column");return this.swapColumnIndexes(e,r)}isItPossibleToSetColumnOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{const r=this._crudOperations.mappingFromOrder(e,t,"column");return this._crudOperations.validateSwapColumnIndexes(e,r),this._crudOperations.testColumnOrderForArrays(e,r),!0}catch(e){return!1}}isItPossibleToAddRows(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeAddedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToAddRows(e,...r),!0}catch(e){return!1}}addRows(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.addRows(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveRows(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeRemovedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToRemoveRows(e,...r),!0}catch(e){return!1}}removeRows(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.removeRows(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToAddColumns(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeAddedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToAddColumns(e,...r),!0}catch(e){return!1}}addColumns(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.addColumns(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveColumns(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeRemovedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToRemoveColumns(e,...r),!0}catch(e){return!1}}removeColumns(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.removeColumns(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveCells(e,t){if(!(0,i.isSimpleCellAddress)(t))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","destinationLeftCorner");if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");try{const r=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.operations.ensureItIsPossibleToMoveCells(r.start,r.width(),r.height(),t),!0}catch(e){return!1}}moveCells(e,t){if(!(0,i.isSimpleCellAddress)(t))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","destinationLeftCorner");if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const r=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.moveCells(r.start,r.width(),r.height(),t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveRows(e,t,r,n){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startRow"),(0,o.validateArgToType)(r,"number","numberOfRows"),(0,o.validateArgToType)(n,"number","targetRow");try{return this._crudOperations.ensureItIsPossibleToMoveRows(e,t,r,n),!0}catch(e){return!1}}moveRows(e,t,r,n){return(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startRow"),(0,o.validateArgToType)(r,"number","numberOfRows"),(0,o.validateArgToType)(n,"number","targetRow"),this._crudOperations.moveRows(e,t,r,n),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveColumns(e,t,r,n){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startColumn"),(0,o.validateArgToType)(r,"number","numberOfColumns"),(0,o.validateArgToType)(n,"number","targetColumn");try{return this._crudOperations.ensureItIsPossibleToMoveColumns(e,t,r,n),!0}catch(e){return!1}}moveColumns(e,t,r,n){return(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startColumn"),(0,o.validateArgToType)(r,"number","numberOfColumns"),(0,o.validateArgToType)(n,"number","targetColumn"),this._crudOperations.moveColumns(e,t,r,n),this.recomputeIfDependencyGraphNeedsIt()}copy(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const t=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.copy(t.start,t.width(),t.height()),this.getRangeValues(e)}cut(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const t=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.cut(t.start,t.width(),t.height()),this.getRangeValues(e)}paste(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","targetLeftCorner");return this.ensureEvaluationIsNotSuspended(),this._crudOperations.paste(e),this.recomputeIfDependencyGraphNeedsIt()}isClipboardEmpty(){return this._crudOperations.isClipboardEmpty()}clearClipboard(){this._crudOperations.clearClipboard()}clearRedoStack(){this._crudOperations.undoRedo.clearRedoStack()}clearUndoStack(){this._crudOperations.undoRedo.clearUndoStack()}getRangeValues(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellValue(e)))}getRangeFormulas(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellFormula(e)))}getRangeSerialized(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellSerialized(e)))}getFillRangeData(e,t,r=!1){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");if(!(0,n.isSimpleCellRange)(t))throw new d.ExpectedValueOfTypeError("SimpleCellRange","target");const o=new n.AbsoluteCellRange(e.start,e.end),s=new n.AbsoluteCellRange(t.start,t.end);return this.ensureEvaluationIsNotSuspended(),s.arrayOfAddressesInRange().map(n=>n.map(n=>{const s=((n.row-(r?t:e).start.row)%o.height()+o.height())%o.height()+e.start.row,i=((n.col-(r?t:e).start.col)%o.width()+o.width())%o.width()+e.start.col;return this._serialization.getCellSerialized({row:s,col:i,sheet:o.sheet},n)}))}isItPossibleToAddSheet(e){(0,o.validateArgToType)(e,"string","sheetName");try{return this._crudOperations.ensureItIsPossibleToAddSheet(e),!0}catch(e){return!1}}addSheet(e){void 0!==e&&(0,o.validateArgToType)(e,"string","sheetName");const t=this._crudOperations.addSheet(e);return this._emitter.emit(h.Events.SheetAdded,t),t}isItPossibleToRemoveSheet(e){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),!0}catch(e){return!1}}removeSheet(e){(0,o.validateArgToType)(e,"number","sheetId");const t=this.sheetMapping.getDisplayName(e);this._crudOperations.removeSheet(e);const r=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.SheetRemoved,t,r),r}isItPossibleToClearSheet(e){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),!0}catch(e){return!1}}clearSheet(e){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.clearSheet(e),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToReplaceSheetContent(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),this._crudOperations.ensureItIsPossibleToChangeSheetContents(e,t),!0}catch(e){return!1}}setSheetContent(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setSheetContent(e,t),this.recomputeIfDependencyGraphNeedsIt()}simpleCellAddressFromString(e,t){return(0,o.validateArgToType)(e,"string","cellAddress"),(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellAddressFromString)(this.sheetMapping.get,e,t)}simpleCellRangeFromString(e,t){return(0,o.validateArgToType)(e,"string","cellRange"),(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellRangeFromString)(this.sheetMapping.get,e,t)}simpleCellAddressToString(e,t){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellAddressToString)(this.sheetMapping.fetchDisplayName,e,t)}simpleCellRangeToString(e,t){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","cellRange");return(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellRangeToString)(this.sheetMapping.fetchDisplayName,e,t)}getCellDependents(e){let t;if((0,i.isSimpleCellAddress)(e))t=this._dependencyGraph.addressMapping.getCell(e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange",e);t=this._dependencyGraph.rangeMapping.getRange(e.start,e.end)}return void 0===t?[]:this._dependencyGraph.getAdjacentNodesAddresses(t)}getCellPrecedents(e){let t;if((0,i.isSimpleCellAddress)(e))t=this._dependencyGraph.addressMapping.getCell(e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange",e);t=this._dependencyGraph.rangeMapping.getRange(e.start,e.end)}return void 0===t?[]:this._dependencyGraph.dependencyQueryAddresses(t)}getSheetName(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.sheetMapping.getDisplayName(e)}getSheetNames(){return this.sheetMapping.sheetNames()}getSheetId(e){return(0,o.validateArgToType)(e,"string","sheetName"),this.sheetMapping.get(e)}doesSheetExist(e){return(0,o.validateArgToType)(e,"string","sheetName"),this.sheetMapping.hasSheetWithName(e)}getCellType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.dependencyGraph.getCell(e);return(0,i.getCellType)(t,e)}doesCellHaveSimpleValue(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.getCellType(e)===i.CellType.VALUE}doesCellHaveFormula(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.getCellType(e);return t===i.CellType.FORMULA||t===i.CellType.ARRAYFORMULA}isCellEmpty(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.getCellType(e)===i.CellType.EMPTY}isCellPartOfArray(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.getCellType(e);return t===i.CellType.ARRAY||t===i.CellType.ARRAYFORMULA}getCellValueType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueType)(t)}getCellValueDetailedType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueDetailedType)(t)}getCellValueFormat(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueFormat)(t)}countSheets(){return this.sheetMapping.numberOfSheets()}isItPossibleToRenameSheet(e,t){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"string","newName");try{return this._crudOperations.ensureItIsPossibleToRenameSheet(e,t),!0}catch(e){return!1}}renameSheet(e,t){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"string","newName");const r=this._crudOperations.renameSheet(e,t);void 0!==r&&this._emitter.emit(h.Events.SheetRenamed,r,t)}batch(e){this.suspendEvaluation(),this._crudOperations.beginUndoRedoBatchMode();try{e()}catch(e){throw this._crudOperations.commitUndoRedoBatchMode(),this.resumeEvaluation(),e}return this._crudOperations.commitUndoRedoBatchMode(),this.resumeEvaluation()}suspendEvaluation(){this._evaluationSuspended=!0,this._emitter.emit(h.Events.EvaluationSuspended)}resumeEvaluation(){this._evaluationSuspended=!1;const e=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.EvaluationResumed,e),e}isEvaluationSuspended(){return this._evaluationSuspended}isItPossibleToAddNamedExpression(e,t,r){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope");try{return this._crudOperations.ensureItIsPossibleToAddNamedExpression(e,t,r),!0}catch(e){return!1}}addNamedExpression(e,t,r,n){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope"),this._crudOperations.addNamedExpression(e,t,r,n);const s=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.NamedExpressionAdded,e,s),s}getNamedExpressionValue(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope"),this.ensureEvaluationIsNotSuspended(),this._crudOperations.ensureScopeIdIsValid(t);const r=this._namedExpressions.namedExpressionForScope(e,t);return r?this._serialization.getCellValue(r.address):void 0}getNamedExpressionFormula(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope"),this._crudOperations.ensureScopeIdIsValid(t);const r=this._namedExpressions.namedExpressionForScope(e,t);return void 0===r?void 0:this._serialization.getCellFormula(r.address)}getNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");const r=this._namedExpressions.namedExpressionForScope(e,t);if(void 0!==r)return{name:e,scope:t,expression:this._serialization.getCellFormula(r.address),options:r.options}}isItPossibleToChangeNamedExpression(e,t,r){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope");try{return this._crudOperations.ensureItIsPossibleToChangeNamedExpression(e,t,r),!0}catch(e){return!1}}changeNamedExpression(e,t,r,n){return(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope"),this._crudOperations.changeNamedExpressionExpression(e,r,t,n),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");try{return this._crudOperations.isItPossibleToRemoveNamedExpression(e,t),!0}catch(e){return!1}}removeNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");const r=this._crudOperations.removeNamedExpression(e,t);if(r){const e=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.NamedExpressionRemoved,r.displayName,e),e}return[]}listNamedExpressions(e){return void 0!==e&&(0,o.validateArgToType)(e,"number","scope"),this._crudOperations.ensureScopeIdIsValid(e),this._namedExpressions.getAllNamedExpressionsNamesInScope(e)}getAllNamedExpressionsSerialized(){return this._serialization.getAllNamedExpressionsSerialized()}normalizeFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t,address:r}=this.extractTemporaryFormula(e);if(void 0===t)throw new d.NotAFormulaError;return this._unparser.unparse(t,r)}calculateFormula(e,t){(0,o.validateArgToType)(e,"string","formulaString"),(0,o.validateArgToType)(t,"number","sheetId"),this._crudOperations.ensureScopeIdIsValid(t);const{ast:r,address:n,dependencies:s}=this.extractTemporaryFormula(e,t);if(void 0===r)throw new d.NotAFormulaError;const i=this.evaluator.runAndForget(r,n,s);return this._exporter.exportScalarOrRange(i)}getNamedExpressionsFromFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t,dependencies:r}=this.extractTemporaryFormula(e);if(void 0===t)throw new d.NotAFormulaError;const n=r.filter(e=>e instanceof f.NamedExpressionDependency).map(e=>e.name);return[...new Set(n)]}validateFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t}=this.extractTemporaryFormula(e);return void 0!==t}getRegisteredFunctionNames(){return E.getLanguage(this._config.language).getFunctionTranslations(this._functionRegistry.getRegisteredFunctionIds())}getFunctionPlugin(e){return(0,o.validateArgToType)(e,"string","functionId"),this._functionRegistry.getFunctionPlugin(e)}getAllFunctionPlugins(){return this._functionRegistry.getPlugins()}numberToDateTime(e){return(0,o.validateArgToType)(e,"number","val"),this._evaluator.interpreter.dateTimeHelper.numberToSimpleDateTime(e)}numberToDate(e){return(0,o.validateArgToType)(e,"number","val"),this._evaluator.interpreter.dateTimeHelper.numberToSimpleDate(e)}numberToTime(e){return(0,o.validateArgToType)(e,"number","val"),(0,c.numberToSimpleTime)(e)}on(e,t){this._emitter.on(e,t)}once(e,t){this._emitter.once(e,t)}off(e,t){this._emitter.off(e,t)}destroy(){(0,l.objectDestroy)(this)}ensureEvaluationIsNotSuspended(){if(this._evaluationSuspended)throw new d.EvaluationSuspendedError}extractTemporaryFormula(e,t=1){const r=this._cellContentParser.parse(e),n={sheet:t,col:0,row:0};if(!(r instanceof a.CellContent.Formula))return{address:n,dependencies:[]};const{ast:o,errors:s,dependencies:i}=this._parser.parse(r.formula,n);return s.length>0?{address:n,dependencies:[]}:{ast:o,address:n,dependencies:i}}rebuildWithConfig(e){const t=this._config.mergeConfig(e),r=this._config.mergeConfig({language:e.language}),n=this._serialization.withNewConfig(r,this._namedExpressions).getAllSheetsSerialized(),o=this._serialization.getAllNamedExpressionsSerialized(),i=s.BuildEngineFactory.rebuildWithConfig(t,n,o,this._stats);this._config=i.config,this._stats=i.stats,this._dependencyGraph=i.dependencyGraph,this._columnSearch=i.columnSearch,this._parser=i.parser,this._unparser=i.unparser,this._cellContentParser=i.cellContentParser,this._evaluator=i.evaluator,this._lazilyTransformingAstService=i.lazilyTransformingAstService,this._crudOperations=i.crudOperations,this._exporter=i.exporter,this._namedExpressions=i.namedExpressions,this._serialization=i.serialization,this._functionRegistry=i.functionRegistry}recomputeIfDependencyGraphNeedsIt(){if(this._evaluationSuspended)return[];{const e=this._crudOperations.getAndClearContentChanges(),t=this.dependencyGraph.verticesToRecompute();this.dependencyGraph.clearDirtyVertices(),t.length>0&&e.addAll(this.evaluator.partialRun(t));const r=e.exportChanges(this._exporter);return e.isEmpty()||this._emitter.emit(h.Events.ValuesUpdated,r),r}}}t.HyperFormula=E,E.version="2.7.0",E.buildDate="10/04/2024 13:38:59",E.releaseDate="10/04/2024",E.languages={},E.registeredLanguages=new Map},function(e,t,r){"use strict";t.__esModule=!0,t.BuildEngineFactory=void 0;var n=r(1),o=r(182),s=r(183),i=r(171),a=r(184),u=r(174),c=r(74),l=r(147),h=r(197),d=r(198),p=r(199),m=r(158),g=r(168),f=r(200),E=r(202),T=r(204),y=r(206),A=r(185),R=r(211),N=r(186),S=r(77),C=r(212),v=r(195),O=r(142),I=r(196);t.BuildEngineFactory= +class E{constructor(e,t,r,n,o,s,i,a,u,c,l,d,p,m){this._config=e,this._stats=t,this._dependencyGraph=r,this._columnSearch=n,this._parser=o,this._unparser=s,this._cellContentParser=i,this._evaluator=a,this._lazilyTransformingAstService=u,this._crudOperations=c,this._exporter=l,this._namedExpressions=d,this._serialization=p,this._functionRegistry=m,this._emitter=new h.Emitter,this._evaluationSuspended=!1}static get defaultConfig(){return(0,u.getDefaultConfig)()}get graph(){return this.dependencyGraph.graph}get rangeMapping(){return this.dependencyGraph.rangeMapping}get arrayMapping(){return this.dependencyGraph.arrayMapping}get sheetMapping(){return this.dependencyGraph.sheetMapping}get addressMapping(){return this.dependencyGraph.addressMapping}get dependencyGraph(){return this._dependencyGraph}get evaluator(){return this._evaluator}get columnSearch(){return this._columnSearch}get lazilyTransformingAstService(){return this._lazilyTransformingAstService}get licenseKeyValidityState(){return this._config.licenseKeyValidityState}static buildFromArray(e,t={},r=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildFromSheet(e,t,r))}static buildFromSheets(e,t={},r=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildFromSheets(e,t,r))}static buildEmpty(e={},t=[]){return this.buildFromEngineState(s.BuildEngineFactory.buildEmpty(e,t))}static getLanguage(e){(0,o.validateArgToType)(e,"string","languageCode");const t=this.registeredLanguages.get(e);if(void 0===t)throw new d.LanguageNotRegisteredError;return t}static registerLanguage(e,t){if((0,o.validateArgToType)(e,"string","languageCode"),this.registeredLanguages.has(e))throw new d.LanguageAlreadyRegisteredError;this.registeredLanguages.set(e,(0,p.buildTranslationPackage)(t))}static unregisterLanguage(e){if((0,o.validateArgToType)(e,"string","languageCode"),!this.registeredLanguages.has(e))throw new d.LanguageNotRegisteredError;this.registeredLanguages.delete(e)}static getRegisteredLanguagesCodes(){return Array.from(this.registeredLanguages.keys())}static registerFunctionPlugin(e,t){m.FunctionRegistry.registerFunctionPlugin(e,t)}static unregisterFunctionPlugin(e){m.FunctionRegistry.unregisterFunctionPlugin(e)}static registerFunction(e,t,r){(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.registerFunction(e,t,r)}static unregisterFunction(e){(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.unregisterFunction(e)}static unregisterAllFunctions(){m.FunctionRegistry.unregisterAll()}static getRegisteredFunctionNames(e){(0,o.validateArgToType)(e,"string","code");const t=m.FunctionRegistry.getRegisteredFunctionIds();return this.getLanguage(e).getFunctionTranslations(t)}static getFunctionPlugin(e){return(0,o.validateArgToType)(e,"string","functionId"),m.FunctionRegistry.getFunctionPlugin(e)}static getAllFunctionPlugins(){return m.FunctionRegistry.getPlugins()}static buildFromEngineState(e){return new E(e.config,e.stats,e.dependencyGraph,e.columnSearch,e.parser,e.unparser,e.cellContentParser,e.evaluator,e.lazilyTransformingAstService,e.crudOperations,e.exporter,e.namedExpressions,e.serialization,e.functionRegistry)}getCellValue(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellValue(e)}getCellFormula(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this._serialization.getCellFormula(e)}getCellHyperlink(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellHyperlink(e)}getCellSerialized(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.ensureEvaluationIsNotSuspended(),this._serialization.getCellSerialized(e)}getSheetValues(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.ensureEvaluationIsNotSuspended(),this._serialization.getSheetValues(e)}getSheetFormulas(e){return(0,o.validateArgToType)(e,"number","sheetId"),this._serialization.getSheetFormulas(e)}getSheetSerialized(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.ensureEvaluationIsNotSuspended(),this._serialization.getSheetSerialized(e)}getAllSheetsDimensions(){return this._serialization.genericAllSheetsGetter(e=>this.getSheetDimensions(e))}getSheetDimensions(e){return(0,o.validateArgToType)(e,"number","sheetId"),{width:this.dependencyGraph.getSheetWidth(e),height:this.dependencyGraph.getSheetHeight(e)}}getAllSheetsValues(){return this.ensureEvaluationIsNotSuspended(),this._serialization.getAllSheetsValues()}getAllSheetsFormulas(){return this._serialization.getAllSheetsFormulas()}getAllSheetsSerialized(){return this.ensureEvaluationIsNotSuspended(),this._serialization.getAllSheetsSerialized()}updateConfig(e){Object.entries(e).every(([e,t])=>this._config[e]===t)||this.rebuildWithConfig(e)}getConfig(){return this._config.getConfig()}rebuildAndRecalculate(){this.rebuildWithConfig({})}getStats(){return this._stats.snapshot()}undo(){return this._crudOperations.undo(),this.recomputeIfDependencyGraphNeedsIt()}redo(){return this._crudOperations.redo(),this.recomputeIfDependencyGraphNeedsIt()}isThereSomethingToUndo(){return this._crudOperations.isThereSomethingToUndo()}isThereSomethingToRedo(){return this._crudOperations.isThereSomethingToRedo()}isItPossibleToSetCellContents(e){let t;if((0,i.isSimpleCellAddress)(e))t=new n.AbsoluteCellRange(e,e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange","address");t=new n.AbsoluteCellRange(e.start,e.end)}try{this._crudOperations.ensureRangeInSizeLimits(t);for(const e of t.addresses(this._dependencyGraph))this._crudOperations.ensureItIsPossibleToChangeContent(e)}catch(e){return!1}return!0}setCellContents(e,t){return this._crudOperations.setCellContents(e,t),this.recomputeIfDependencyGraphNeedsIt()}swapRowIndexes(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setRowOrder(e,t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToSwapRowIndexes(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.validateSwapRowIndexes(e,t),this._crudOperations.testRowOrderForArrays(e,t),!0}catch(e){return!1}}setRowOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");const r=this._crudOperations.mappingFromOrder(e,t,"row");return this.swapRowIndexes(e,r)}isItPossibleToSetRowOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{const r=this._crudOperations.mappingFromOrder(e,t,"row");return this._crudOperations.validateSwapRowIndexes(e,r),this._crudOperations.testRowOrderForArrays(e,r),!0}catch(e){return!1}}swapColumnIndexes(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setColumnOrder(e,t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToSwapColumnIndexes(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.validateSwapColumnIndexes(e,t),this._crudOperations.testColumnOrderForArrays(e,t),!0}catch(e){return!1}}setColumnOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");const r=this._crudOperations.mappingFromOrder(e,t,"column");return this.swapColumnIndexes(e,r)}isItPossibleToSetColumnOrder(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{const r=this._crudOperations.mappingFromOrder(e,t,"column");return this._crudOperations.validateSwapColumnIndexes(e,r),this._crudOperations.testColumnOrderForArrays(e,r),!0}catch(e){return!1}}isItPossibleToAddRows(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeAddedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToAddRows(e,...r),!0}catch(e){return!1}}addRows(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.addRows(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveRows(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeRemovedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToRemoveRows(e,...r),!0}catch(e){return!1}}removeRows(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.removeRows(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToAddColumns(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeAddedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToAddColumns(e,...r),!0}catch(e){return!1}}addColumns(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.addColumns(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveColumns(e,...t){(0,o.validateArgToType)(e,"number","sheetId");const r=(0,g.normalizeRemovedIndexes)(t);try{return this._crudOperations.ensureItIsPossibleToRemoveColumns(e,...r),!0}catch(e){return!1}}removeColumns(e,...t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.removeColumns(e,...t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveCells(e,t){if(!(0,i.isSimpleCellAddress)(t))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","destinationLeftCorner");if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");try{const r=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.operations.ensureItIsPossibleToMoveCells(r.start,r.width(),r.height(),t),!0}catch(e){return!1}}moveCells(e,t){if(!(0,i.isSimpleCellAddress)(t))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","destinationLeftCorner");if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const r=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.moveCells(r.start,r.width(),r.height(),t),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveRows(e,t,r,n){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startRow"),(0,o.validateArgToType)(r,"number","numberOfRows"),(0,o.validateArgToType)(n,"number","targetRow");try{return this._crudOperations.ensureItIsPossibleToMoveRows(e,t,r,n),!0}catch(e){return!1}}moveRows(e,t,r,n){return(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startRow"),(0,o.validateArgToType)(r,"number","numberOfRows"),(0,o.validateArgToType)(n,"number","targetRow"),this._crudOperations.moveRows(e,t,r,n),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToMoveColumns(e,t,r,n){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startColumn"),(0,o.validateArgToType)(r,"number","numberOfColumns"),(0,o.validateArgToType)(n,"number","targetColumn");try{return this._crudOperations.ensureItIsPossibleToMoveColumns(e,t,r,n),!0}catch(e){return!1}}moveColumns(e,t,r,n){return(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"number","startColumn"),(0,o.validateArgToType)(r,"number","numberOfColumns"),(0,o.validateArgToType)(n,"number","targetColumn"),this._crudOperations.moveColumns(e,t,r,n),this.recomputeIfDependencyGraphNeedsIt()}copy(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const t=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.copy(t.start,t.width(),t.height()),this.getRangeValues(e)}cut(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");const t=new n.AbsoluteCellRange(e.start,e.end);return this._crudOperations.cut(t.start,t.width(),t.height()),this.getRangeValues(e)}paste(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","targetLeftCorner");return this.ensureEvaluationIsNotSuspended(),this._crudOperations.paste(e),this.recomputeIfDependencyGraphNeedsIt()}isClipboardEmpty(){return this._crudOperations.isClipboardEmpty()}clearClipboard(){this._crudOperations.clearClipboard()}clearRedoStack(){this._crudOperations.undoRedo.clearRedoStack()}clearUndoStack(){this._crudOperations.undoRedo.clearUndoStack()}getRangeValues(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellValue(e)))}getRangeFormulas(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellFormula(e)))}getRangeSerialized(e){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");return new n.AbsoluteCellRange(e.start,e.end).arrayOfAddressesInRange().map(e=>e.map(e=>this.getCellSerialized(e)))}getFillRangeData(e,t,r=!1){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","source");if(!(0,n.isSimpleCellRange)(t))throw new d.ExpectedValueOfTypeError("SimpleCellRange","target");const o=new n.AbsoluteCellRange(e.start,e.end),s=new n.AbsoluteCellRange(t.start,t.end);return this.ensureEvaluationIsNotSuspended(),s.arrayOfAddressesInRange().map(n=>n.map(n=>{const s=((n.row-(r?t:e).start.row)%o.height()+o.height())%o.height()+e.start.row,i=((n.col-(r?t:e).start.col)%o.width()+o.width())%o.width()+e.start.col;return this._serialization.getCellSerialized({row:s,col:i,sheet:o.sheet},n)}))}isItPossibleToAddSheet(e){(0,o.validateArgToType)(e,"string","sheetName");try{return this._crudOperations.ensureItIsPossibleToAddSheet(e),!0}catch(e){return!1}}addSheet(e){void 0!==e&&(0,o.validateArgToType)(e,"string","sheetName");const t=this._crudOperations.addSheet(e);return this._emitter.emit(h.Events.SheetAdded,t),t}isItPossibleToRemoveSheet(e){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),!0}catch(e){return!1}}removeSheet(e){(0,o.validateArgToType)(e,"number","sheetId");const t=this.sheetMapping.getDisplayName(e);this._crudOperations.removeSheet(e);const r=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.SheetRemoved,t,r),r}isItPossibleToClearSheet(e){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),!0}catch(e){return!1}}clearSheet(e){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.clearSheet(e),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToReplaceSheetContent(e,t){(0,o.validateArgToType)(e,"number","sheetId");try{return this._crudOperations.ensureScopeIdIsValid(e),this._crudOperations.ensureItIsPossibleToChangeSheetContents(e,t),!0}catch(e){return!1}}setSheetContent(e,t){return(0,o.validateArgToType)(e,"number","sheetId"),this._crudOperations.setSheetContent(e,t),this.recomputeIfDependencyGraphNeedsIt()}simpleCellAddressFromString(e,t){return(0,o.validateArgToType)(e,"string","cellAddress"),(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellAddressFromString)(this.sheetMapping.get,e,t)}simpleCellRangeFromString(e,t){return(0,o.validateArgToType)(e,"string","cellRange"),(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellRangeFromString)(this.sheetMapping.get,e,t)}simpleCellAddressToString(e,t){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellAddressToString)(this.sheetMapping.fetchDisplayName,e,t)}simpleCellRangeToString(e,t){if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellRange","cellRange");return(0,o.validateArgToType)(t,"number","sheetId"),(0,f.simpleCellRangeToString)(this.sheetMapping.fetchDisplayName,e,t)}getCellDependents(e){let t;if((0,i.isSimpleCellAddress)(e))t=this._dependencyGraph.addressMapping.getCell(e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange",e);t=this._dependencyGraph.rangeMapping.getRange(e.start,e.end)}return void 0===t?[]:this._dependencyGraph.getAdjacentNodesAddresses(t)}getCellPrecedents(e){let t;if((0,i.isSimpleCellAddress)(e))t=this._dependencyGraph.addressMapping.getCell(e);else{if(!(0,n.isSimpleCellRange)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress | SimpleCellRange",e);t=this._dependencyGraph.rangeMapping.getRange(e.start,e.end)}return void 0===t?[]:this._dependencyGraph.dependencyQueryAddresses(t)}getSheetName(e){return(0,o.validateArgToType)(e,"number","sheetId"),this.sheetMapping.getDisplayName(e)}getSheetNames(){return this.sheetMapping.sheetNames()}getSheetId(e){return(0,o.validateArgToType)(e,"string","sheetName"),this.sheetMapping.get(e)}doesSheetExist(e){return(0,o.validateArgToType)(e,"string","sheetName"),this.sheetMapping.hasSheetWithName(e)}getCellType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.dependencyGraph.getCell(e);return(0,i.getCellType)(t,e)}doesCellHaveSimpleValue(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.getCellType(e)===i.CellType.VALUE}doesCellHaveFormula(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.getCellType(e);return t===i.CellType.FORMULA||t===i.CellType.ARRAYFORMULA}isCellEmpty(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");return this.getCellType(e)===i.CellType.EMPTY}isCellPartOfArray(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");const t=this.getCellType(e);return t===i.CellType.ARRAY||t===i.CellType.ARRAYFORMULA}getCellValueType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueType)(t)}getCellValueDetailedType(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueDetailedType)(t)}getCellValueFormat(e){if(!(0,i.isSimpleCellAddress)(e))throw new d.ExpectedValueOfTypeError("SimpleCellAddress","cellAddress");this.ensureEvaluationIsNotSuspended();const t=this.dependencyGraph.getCellValue(e);return(0,i.getCellValueFormat)(t)}countSheets(){return this.sheetMapping.numberOfSheets()}isItPossibleToRenameSheet(e,t){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"string","newName");try{return this._crudOperations.ensureItIsPossibleToRenameSheet(e,t),!0}catch(e){return!1}}renameSheet(e,t){(0,o.validateArgToType)(e,"number","sheetId"),(0,o.validateArgToType)(t,"string","newName");const r=this._crudOperations.renameSheet(e,t);void 0!==r&&this._emitter.emit(h.Events.SheetRenamed,r,t)}batch(e){this.suspendEvaluation(),this._crudOperations.beginUndoRedoBatchMode();try{e()}catch(e){throw this._crudOperations.commitUndoRedoBatchMode(),this.resumeEvaluation(),e}return this._crudOperations.commitUndoRedoBatchMode(),this.resumeEvaluation()}suspendEvaluation(){this._evaluationSuspended=!0,this._emitter.emit(h.Events.EvaluationSuspended)}resumeEvaluation(){this._evaluationSuspended=!1;const e=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.EvaluationResumed,e),e}isEvaluationSuspended(){return this._evaluationSuspended}isItPossibleToAddNamedExpression(e,t,r){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope");try{return this._crudOperations.ensureItIsPossibleToAddNamedExpression(e,t,r),!0}catch(e){return!1}}addNamedExpression(e,t,r,n){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope"),this._crudOperations.addNamedExpression(e,t,r,n);const s=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.NamedExpressionAdded,e,s),s}getNamedExpressionValue(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope"),this.ensureEvaluationIsNotSuspended(),this._crudOperations.ensureScopeIdIsValid(t);const r=this._namedExpressions.namedExpressionForScope(e,t);return r?this._serialization.getCellValue(r.address):void 0}getNamedExpressionFormula(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope"),this._crudOperations.ensureScopeIdIsValid(t);const r=this._namedExpressions.namedExpressionForScope(e,t);return void 0===r?void 0:this._serialization.getCellFormula(r.address)}getNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");const r=this._namedExpressions.namedExpressionForScope(e,t);if(void 0!==r)return{name:e,scope:t,expression:this._serialization.getCellFormula(r.address),options:r.options}}isItPossibleToChangeNamedExpression(e,t,r){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope");try{return this._crudOperations.ensureItIsPossibleToChangeNamedExpression(e,t,r),!0}catch(e){return!1}}changeNamedExpression(e,t,r,n){return(0,o.validateArgToType)(e,"string","expressionName"),void 0!==r&&(0,o.validateArgToType)(r,"number","scope"),this._crudOperations.changeNamedExpressionExpression(e,r,t,n),this.recomputeIfDependencyGraphNeedsIt()}isItPossibleToRemoveNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");try{return this._crudOperations.isItPossibleToRemoveNamedExpression(e,t),!0}catch(e){return!1}}removeNamedExpression(e,t){(0,o.validateArgToType)(e,"string","expressionName"),void 0!==t&&(0,o.validateArgToType)(t,"number","scope");const r=this._crudOperations.removeNamedExpression(e,t);if(r){const e=this.recomputeIfDependencyGraphNeedsIt();return this._emitter.emit(h.Events.NamedExpressionRemoved,r.displayName,e),e}return[]}listNamedExpressions(e){return void 0!==e&&(0,o.validateArgToType)(e,"number","scope"),this._crudOperations.ensureScopeIdIsValid(e),this._namedExpressions.getAllNamedExpressionsNamesInScope(e)}getAllNamedExpressionsSerialized(){return this._serialization.getAllNamedExpressionsSerialized()}normalizeFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t,address:r}=this.extractTemporaryFormula(e);if(void 0===t)throw new d.NotAFormulaError;return this._unparser.unparse(t,r)}calculateFormula(e,t){(0,o.validateArgToType)(e,"string","formulaString"),(0,o.validateArgToType)(t,"number","sheetId"),this._crudOperations.ensureScopeIdIsValid(t);const{ast:r,address:n,dependencies:s}=this.extractTemporaryFormula(e,t);if(void 0===r)throw new d.NotAFormulaError;const i=this.evaluator.runAndForget(r,n,s);return this._exporter.exportScalarOrRange(i)}getNamedExpressionsFromFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t,dependencies:r}=this.extractTemporaryFormula(e);if(void 0===t)throw new d.NotAFormulaError;const n=r.filter(e=>e instanceof f.NamedExpressionDependency).map(e=>e.name);return[...new Set(n)]}validateFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t}=this.extractTemporaryFormula(e);return void 0!==t}getRegisteredFunctionNames(){return E.getLanguage(this._config.language).getFunctionTranslations(this._functionRegistry.getRegisteredFunctionIds())}getFunctionPlugin(e){return(0,o.validateArgToType)(e,"string","functionId"),this._functionRegistry.getFunctionPlugin(e)}getAllFunctionPlugins(){return this._functionRegistry.getPlugins()}numberToDateTime(e){return(0,o.validateArgToType)(e,"number","val"),this._evaluator.interpreter.dateTimeHelper.numberToSimpleDateTime(e)}numberToDate(e){return(0,o.validateArgToType)(e,"number","val"),this._evaluator.interpreter.dateTimeHelper.numberToSimpleDate(e)}numberToTime(e){return(0,o.validateArgToType)(e,"number","val"),(0,c.numberToSimpleTime)(e)}on(e,t){this._emitter.on(e,t)}once(e,t){this._emitter.once(e,t)}off(e,t){this._emitter.off(e,t)}destroy(){(0,l.objectDestroy)(this)}ensureEvaluationIsNotSuspended(){if(this._evaluationSuspended)throw new d.EvaluationSuspendedError}extractTemporaryFormula(e,t=1){const r=this._cellContentParser.parse(e),n={sheet:t,col:0,row:0};if(!(r instanceof a.CellContent.Formula))return{address:n,dependencies:[]};const{ast:o,errors:s,dependencies:i}=this._parser.parse(r.formula,n);return s.length>0?{address:n,dependencies:[]}:{ast:o,address:n,dependencies:i}}rebuildWithConfig(e){const t=this._config.mergeConfig(e),r=this._config.mergeConfig({language:e.language}),n=this._serialization.withNewConfig(r,this._namedExpressions).getAllSheetsSerialized(),o=this._serialization.getAllNamedExpressionsSerialized(),i=s.BuildEngineFactory.rebuildWithConfig(t,n,o,this._stats);this._config=i.config,this._stats=i.stats,this._dependencyGraph=i.dependencyGraph,this._columnSearch=i.columnSearch,this._parser=i.parser,this._unparser=i.unparser,this._cellContentParser=i.cellContentParser,this._evaluator=i.evaluator,this._lazilyTransformingAstService=i.lazilyTransformingAstService,this._crudOperations=i.crudOperations,this._exporter=i.exporter,this._namedExpressions=i.namedExpressions,this._serialization=i.serialization,this._functionRegistry=i.functionRegistry}recomputeIfDependencyGraphNeedsIt(){if(this._evaluationSuspended)return[];{const e=this._crudOperations.getAndClearContentChanges(),t=this.dependencyGraph.verticesToRecompute();this.dependencyGraph.clearDirtyVertices(),t.length>0&&e.addAll(this.evaluator.partialRun(t));const r=e.exportChanges(this._exporter);return e.isEmpty()||this._emitter.emit(h.Events.ValuesUpdated,r),r}}}t.HyperFormula=E,E.version="2.7.0",E.buildDate="20/06/2024 10:19:30",E.releaseDate="10/04/2024",E.languages={},E.registeredLanguages=new Map},function(e,t,r){"use strict";t.__esModule=!0,t.BuildEngineFactory=void 0;var n=r(1),o=r(182),s=r(183),i=r(171),a=r(184),u=r(174),c=r(74),l=r(147),h=r(197),d=r(198),p=r(199),m=r(158),g=r(168),f=r(200),E=r(202),T=r(204),y=r(206),A=r(185),R=r(211),N=r(186),S=r(77),C=r(212),v=r(195),O=r(142),I=r(196);t.BuildEngineFactory= /** * @license * Copyright (c) 2024 Handsoncode. All rights reserved. diff --git a/assets/js/25.9bed9b62.js b/assets/js/25.f6eb2894.js similarity index 99% rename from assets/js/25.9bed9b62.js rename to assets/js/25.f6eb2894.js index 4728befe7..7e47ba5ab 100644 --- a/assets/js/25.9bed9b62.js +++ b/assets/js/25.f6eb2894.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{317:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[t._v("Welcome to the HyperFormula "),s("code",[t._v("v"+t._s(t.$page.version))]),t._v(" API!")]),t._v(" "),s("p",[t._v("The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.")]),t._v(" "),s("p",[t._v("Current build: "+t._s(t.$page.buildDate))]),t._v(" "),s("h3",{attrs:{id:"api-reference-index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#api-reference-index"}},[t._v("#")]),t._v(" API reference index")]),t._v(" "),s("p",[t._v("The following sections explain shortly what can be found in the left sidebar navigation menu.")]),t._v(" "),s("h4",{attrs:{id:"hyperformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula"}},[t._v("#")]),t._v(" HyperFormula")]),t._v(" "),s("p",[t._v("This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.")]),t._v(" "),s("p",[t._v("The snippet shows an example how to use "),s("code",[t._v("buildFromArray")]),t._v(" which is one of "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#factories"}},[t._v("three static methods")]),t._v(" for creating an instance of HyperFormula:")],1),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'52'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'91'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"configparams"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configparams"}},[t._v("#")]),t._v(" ConfigParams")]),t._v(" "),s("p",[t._v("This section contains information about options that allow you to configure the instance of HyperFormula.")]),t._v(" "),s("p",[t._v("An example set of options:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" options "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("licenseKey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gpl-v3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nullDate")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("year")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1900")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("month")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("day")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("functionArgSeparator")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'.'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"listeners"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listeners"}},[t._v("#")]),t._v(" Listeners")]),t._v(" "),s("p",[t._v("In this section, you can find information about all events you can subscribe to.")]),t._v(" "),s("p",[t._v("For example, subscribing to "),s("code",[t._v("sheetAdded")]),t._v(" event:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nameProvided "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{321:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[t._v("Welcome to the HyperFormula "),s("code",[t._v("v"+t._s(t.$page.version))]),t._v(" API!")]),t._v(" "),s("p",[t._v("The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.")]),t._v(" "),s("p",[t._v("Current build: "+t._s(t.$page.buildDate))]),t._v(" "),s("h3",{attrs:{id:"api-reference-index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#api-reference-index"}},[t._v("#")]),t._v(" API reference index")]),t._v(" "),s("p",[t._v("The following sections explain shortly what can be found in the left sidebar navigation menu.")]),t._v(" "),s("h4",{attrs:{id:"hyperformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula"}},[t._v("#")]),t._v(" HyperFormula")]),t._v(" "),s("p",[t._v("This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.")]),t._v(" "),s("p",[t._v("The snippet shows an example how to use "),s("code",[t._v("buildFromArray")]),t._v(" which is one of "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#factories"}},[t._v("three static methods")]),t._v(" for creating an instance of HyperFormula:")],1),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'52'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'91'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"configparams"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configparams"}},[t._v("#")]),t._v(" ConfigParams")]),t._v(" "),s("p",[t._v("This section contains information about options that allow you to configure the instance of HyperFormula.")]),t._v(" "),s("p",[t._v("An example set of options:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" options "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("licenseKey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gpl-v3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nullDate")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("year")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1900")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("month")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("day")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("functionArgSeparator")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'.'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"listeners"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listeners"}},[t._v("#")]),t._v(" Listeners")]),t._v(" "),s("p",[t._v("In this section, you can find information about all events you can subscribe to.")]),t._v(" "),s("p",[t._v("For example, subscribing to "),s("code",[t._v("sheetAdded")]),t._v(" event:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nameProvided "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/27.11b6a3ff.js b/assets/js/27.1eb07f4b.js similarity index 95% rename from assets/js/27.11b6a3ff.js rename to assets/js/27.1eb07f4b.js index 929a134f7..997b6fad2 100644 --- a/assets/js/27.11b6a3ff.js +++ b/assets/js/27.1eb07f4b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{320:function(t,v,e){"use strict";e.r(v);var _=e(14),r=Object(_.a)({},(function(){var t=this,v=t._self._c;return v("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[v("h1",{attrs:{id:"emitter"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#emitter"}},[t._v("#")]),t._v(" Emitter "),v("Badge",{attrs:{text:"Class"}})],1),t._v(" "),v("h2",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),v("h3",{attrs:{id:"emit"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#emit"}},[t._v("#")]),t._v(" emit")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("emit")]),t._v("‹"),v("strong",[t._v("Event")]),t._v("›("),v("code",[t._v("event")]),t._v(": Event, ..."),v("code",[t._v("args")]),t._v(": Parameters‹Listeners[Event]›): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("em",[t._v("Defined in "),v("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L328",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:328"),v("OutboundLink")],1)])]),t._v(" "),v("p",[v("strong",[t._v("Type parameters:")])]),t._v(" "),v("p",[t._v("▪ "),v("strong",[t._v("Event")]),t._v(": "),v("em",[t._v("keyof Listeners")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("Event")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("...args")])]),t._v(" "),v("td",[t._v("Parameters‹Listeners[Event]›")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"off"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("off")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback?")]),t._v(": Function): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback?")])]),t._v(" "),v("td",[t._v("Function")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"on"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("on")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback")]),t._v(": Function, "),v("code",[t._v("ctx?")]),t._v(": any): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback")])]),t._v(" "),v("td",[t._v("Function")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("ctx?")])]),t._v(" "),v("td",[t._v("any")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"once"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("once")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback")]),t._v(": Function, "),v("code",[t._v("ctx?")]),t._v(": any): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback")])]),t._v(" "),v("td",[t._v("Function")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("ctx?")])]),t._v(" "),v("td",[t._v("any")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])])])}),[],!1,null,null,null);v.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{319:function(t,v,e){"use strict";e.r(v);var _=e(14),r=Object(_.a)({},(function(){var t=this,v=t._self._c;return v("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[v("h1",{attrs:{id:"emitter"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#emitter"}},[t._v("#")]),t._v(" Emitter "),v("Badge",{attrs:{text:"Class"}})],1),t._v(" "),v("h2",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),v("h3",{attrs:{id:"emit"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#emit"}},[t._v("#")]),t._v(" emit")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("emit")]),t._v("‹"),v("strong",[t._v("Event")]),t._v("›("),v("code",[t._v("event")]),t._v(": Event, ..."),v("code",[t._v("args")]),t._v(": Parameters‹Listeners[Event]›): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("em",[t._v("Defined in "),v("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L328",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:328"),v("OutboundLink")],1)])]),t._v(" "),v("p",[v("strong",[t._v("Type parameters:")])]),t._v(" "),v("p",[t._v("▪ "),v("strong",[t._v("Event")]),t._v(": "),v("em",[t._v("keyof Listeners")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("Event")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("...args")])]),t._v(" "),v("td",[t._v("Parameters‹Listeners[Event]›")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"off"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("off")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback?")]),t._v(": Function): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback?")])]),t._v(" "),v("td",[t._v("Function")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"on"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("on")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback")]),t._v(": Function, "),v("code",[t._v("ctx?")]),t._v(": any): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback")])]),t._v(" "),v("td",[t._v("Function")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("ctx?")])]),t._v(" "),v("td",[t._v("any")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])]),t._v(" "),v("hr"),t._v(" "),v("h3",{attrs:{id:"once"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),v("p",[t._v("▸ "),v("strong",[t._v("once")]),t._v("("),v("code",[t._v("event")]),t._v(": string, "),v("code",[t._v("callback")]),t._v(": Function, "),v("code",[t._v("ctx?")]),t._v(": any): "),v("em",[t._v("this")])]),t._v(" "),v("p",[v("strong",[t._v("Parameters:")])]),t._v(" "),v("table",[v("thead",[v("tr",[v("th",[t._v("Name")]),t._v(" "),v("th",[t._v("Type")])])]),t._v(" "),v("tbody",[v("tr",[v("td",[v("code",[t._v("event")])]),t._v(" "),v("td",[t._v("string")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("callback")])]),t._v(" "),v("td",[t._v("Function")])]),t._v(" "),v("tr",[v("td",[v("code",[t._v("ctx?")])]),t._v(" "),v("td",[t._v("any")])])])]),t._v(" "),v("p",[v("strong",[t._v("Returns:")]),t._v(" "),v("em",[t._v("this")])])])}),[],!1,null,null,null);v.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/28.9a5300e8.js b/assets/js/28.a6b42c2e.js similarity index 98% rename from assets/js/28.9a5300e8.js rename to assets/js/28.a6b42c2e.js index ae9447cb9..2fac988b9 100644 --- a/assets/js/28.9a5300e8.js +++ b/assets/js/28.a6b42c2e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{322:function(t,s,e){"use strict";e.r(s);var a=e(14),n=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"hyperformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula"}},[t._v("#")]),t._v(" HyperFormula "),s("Badge",{attrs:{text:"Class"}})],1),t._v(" "),s("p",[t._v("This is a class for creating HyperFormula instance, all the following public methods\nare related to this class.")]),t._v(" "),s("p",[t._v("The instance can be created only by calling one of the static methods\n"),s("code",[t._v("buildFromArray")]),t._v(", "),s("code",[t._v("buildFromSheets")]),t._v(" or "),s("code",[t._v("buildEmpty")]),t._v(" and should be disposed of with the\n"),s("code",[t._v("destroy")]),t._v(" method when it's no longer needed to free the resources.")]),t._v(" "),s("p",[t._v("The instance can be seen as a workbook where worksheets can be created and\nmanipulated. They are organized within a widely known structure of columns and rows\nwhich can be manipulated as well. The smallest possible data unit are the cells, which\nmay contain simple values or formulas to be calculated.")]),t._v(" "),s("p",[t._v("All CRUD methods are called directly on HyperFormula instance and will trigger\ncorresponding lifecycle events. The events are marked accordingly, as well as thrown\nerrors, so they can be correctly handled.")]),t._v(" "),s("h2",{attrs:{id:"static-properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-properties"}},[t._v("#")]),t._v(" Static Properties")]),t._v(" "),s("h3",{attrs:{id:"builddate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#builddate"}},[t._v("#")]),t._v(" buildDate "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("buildDate")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '10/04/2024 13:38:59'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:101"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Latest build date.")]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"languages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#languages"}},[t._v("#")]),t._v(" languages "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("languages")]),t._v(": "),s("em",[t._v("Record‹string, RawTranslationPackage›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:117"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("When using the UMD build, this property contains all available languages to use with the "),s("a",{attrs:{href:"#registerlanguage"}},[t._v("registerLanguage")]),t._v(" method.")]),t._v(" "),s("p",[t._v("For more information, see the "),s("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[t._v("Localizing functions")]),t._v(" guide.")],1),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"releasedate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#releasedate"}},[t._v("#")]),t._v(" releaseDate "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("releaseDate")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '10/04/2024'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L108",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:108"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("A release date.")]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"version"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#version"}},[t._v("#")]),t._v(" version "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("version")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '2.7.0'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:94"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Version of the HyperFormula.")]),t._v(" "),s("h2",{attrs:{id:"static-accessors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-accessors"}},[t._v("#")]),t._v(" Static Accessors")]),t._v(" "),s("h3",{attrs:{id:"defaultconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#defaultconfig"}},[t._v("#")]),t._v(" defaultConfig "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("get defaultConfig")]),t._v("(): "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:156"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all of HyperFormula's default "),s("RouterLink",{attrs:{to:"/guide/configuration-options.html"}},[t._v("configuration options")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns all default configuration options")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" defaultConfig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaultConfig"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[s("code",[t._v("category")])]),t._v(" Static Accessors")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("h2",{attrs:{id:"factories"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#factories"}},[t._v("#")]),t._v(" Factories")]),t._v(" "),s("h3",{attrs:{id:"buildempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildempty"}},[t._v("#")]),t._v(" buildEmpty "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildEmpty")]),t._v("("),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L328",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:328"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds an empty engine instance.\nCan be configured with the optional parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// build with no initial data and with optional config parameter maxColumns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"buildfromarray"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildfromarray"}},[t._v("#")]),t._v(" buildFromArray "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildFromArray")]),t._v("("),s("code",[t._v("sheet")]),t._v(": Sheet, "),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L268",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:268"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds the engine for a sheet from a two-dimensional array representation.\nThe engine is created with a single sheet.\nCan be configured with the optional second parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified, the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when sheet size exceeds the limits")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when sheet is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// data represented as an array")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'52'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'91'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// method with optional config parameter maxColumns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheet")])]),t._v(" "),s("td",[t._v("Sheet")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("two-dimensional array representation of sheet")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"buildfromsheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildfromsheets"}},[t._v("#")]),t._v(" buildFromSheets "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildFromSheets")]),t._v("("),s("code",[t._v("sheets")]),t._v(": Sheets, "),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L308",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:308"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds the engine from an object containing multiple sheets with names.\nThe engine is created with one or more sheets.\nCan be configured with the optional second parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when sheet size exceeds the limits")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when any sheet is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// data represented as an object with sheets: Sheet1 and Sheet2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Sheet2'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(9, 3, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// method with optional config parameter useColumnIndex")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("useColumnIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheets")])]),t._v(" "),s("td",[t._v("Sheets")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("object with sheets definition")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"instance"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#instance"}},[t._v("#")]),t._v(" Instance")]),t._v(" "),s("h3",{attrs:{id:"destroy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" destroy")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("destroy")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4402",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4402"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Destroys instance of HyperFormula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// destroys the instance")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("destroy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getconfig"}},[t._v("#")]),t._v(" getConfig")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getConfig")]),t._v("(): "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1019",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1019"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns current configuration of the engine instance.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all config metadata including default and those which were added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfConfig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getConfig")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"rebuildandrecalculate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rebuildandrecalculate"}},[t._v("#")]),t._v(" rebuildAndRecalculate")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("rebuildAndRecalculate")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1033",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1033"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Rebuilds the HyperFormula instance preserving the current sheets data.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rebuildAndRecalculate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"updateconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("updateConfig")]),t._v("("),s("code",[t._v("newParams")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›): "),s("em",[t._v("void")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L998",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:998"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Updates the config with given new metadata. It is an expensive operation, as it might trigger rebuilding the engine and recalculation of all formulas.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when some parameters of config are of wrong type (e.g., currencySymbol)")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ConfigValueEmpty]] when some parameters of config are of invalid value (e.g., currencySymbol)")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a config param, for example maxColumns,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you can check the configuration with getConfig method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfig")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("newParams")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("configuration options to be updated or added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"sheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheets"}},[t._v("#")]),t._v(" Sheets")]),t._v(" "),s("h3",{attrs:{id:"addsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addsheet"}},[t._v("#")]),t._v(" addSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addSheet")]),t._v("("),s("code",[t._v("sheetName?")]),t._v(": undefined | string): "),s("em",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2571",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2571"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a new sheet to the HyperFormula instance. Returns given or autogenerated name of a new sheet.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetadded"}},[t._v("sheetAdded")]),t._v(" after the sheet was added")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetNameAlreadyTakenError]] when sheet with a given name already exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'MySheet3'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nameProvided "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return autogenerated 'Sheet4'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// because no name was provided and 3 other ones already exist")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" generatedName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName?")])]),t._v(" "),s("td",[t._v("undefined | string")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"clearsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearsheet"}},[t._v("#")]),t._v(" clearSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2718",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2718"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the sheet content. Double-checks if the sheet exists.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"countsheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#countsheets"}},[t._v("#")]),t._v(" countSheets")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("countSheets")]),t._v("(): "),s("em",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3360",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3360"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the number of existing sheets.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return the number of sheets which is '1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetsCount "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("countSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("number")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"doessheetexist"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doessheetexist"}},[t._v("#")]),t._v(" doesSheetExist")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesSheetExist")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3083",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3083"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" whether sheet with a given name exists. The method accepts sheet name to be checked.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since 'MySheet1' exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetExist "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesSheetExist")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("name of the sheet, case-insensitive.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsdimensions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsdimensions"}},[t._v("#")]),t._v(" getAllSheetsDimensions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsDimensions")]),t._v("(): "),s("em",[t._v("Record‹string, SheetDimensions›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L882",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:882"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a map containing dimensions of all sheets for the engine instance represented as a key-value pairs where keys are sheet IDs and dimensions are returned as numbers, width and height respectively.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return the dimensions of all sheets:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// { Sheet1: { width: 3, height: 1 }, Sheet2: { width: 1, height: 2 } }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsDimensions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsDimensions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, SheetDimensions›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsformulas"}},[t._v("#")]),t._v(" getAllSheetsFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsFormulas")]),t._v("(): "),s("em",[t._v("Record‹string, (string | undefined)[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L951",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:951"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns formulas of all sheets in a form of an object which property keys are strings and values are 2D arrays of strings or possibly "),s("code",[t._v("undefined")]),t._v(" when the call does not contain a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return only formulas: { Sheet1: [ [ undefined, undefined, '=A1+10' ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, (string | undefined)[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsserialized"}},[t._v("#")]),t._v(" getAllSheetsSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsSerialized")]),t._v("(): "),s("em",[t._v("Record‹string, RawCellContent[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L972",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:972"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns formulas or values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[RawCellContent]].")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets serialized content: { Sheet1: [ [ 1, 2, '=A1+10' ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsSerialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, RawCellContent[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsvalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsvalues"}},[t._v("#")]),t._v(" getAllSheetsValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsValues")]),t._v("(): "),s("em",[t._v("Record‹string, CellValue[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L932",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:932"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[CellValue]].")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets values: { Sheet1: [ [ 1, 11, 3 ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, CellValue[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetdimensions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetdimensions"}},[t._v("#")]),t._v(" getSheetDimensions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetDimensions")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("SheetDimensions")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L907",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:907"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns dimensions of a specified sheet.\nThe sheet dimensions is represented with numbers: width and height.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return provided sheet's dimensions: { width: 3, height: 1 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetDimensions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetDimensions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SheetDimensions")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetformulas"}},[t._v("#")]),t._v(" getSheetFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetFormulas")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L819",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:819"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array with normalized formula strings from [[Sheet]] or "),s("code",[t._v("undefined")]),t._v(" for a cells that have no value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all formulas of a sheet:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=SUM(1, 2, 3)', '=A1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=TEXT(A2, \"0.0%\")', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=SUM(A1:C1)', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ];")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetid"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetid"}},[t._v("#")]),t._v(" getSheetId")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetId")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("number | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3058",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3058"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a unique sheet ID assigned to the sheet with a given name or "),s("code",[t._v("undefined")]),t._v(" if the sheet does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return '0' because 'MySheet1' is of ID '0'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetID "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("name of the sheet, for which we want to retrieve ID, case-insensitive.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("number | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetname"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetname"}},[t._v("#")]),t._v(" getSheetName")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetName")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3012",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3012"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a unique sheet name assigned to the sheet of a given ID or "),s("code",[t._v("undefined")]),t._v(" if the there is no sheet with a given ID.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'MySheet2' as this sheet is the second one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of the sheet, for which we want to retrieve name")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetnames"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetnames"}},[t._v("#")]),t._v(" getSheetNames")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetNames")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3034",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3034"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("List all sheet names.\nReturns an array of sheet names as strings.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets names: ['MySheet1', 'MySheet2']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetserialized"}},[t._v("#")]),t._v(" getSheetSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetSerialized")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L852",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:852"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array of arrays of [[RawCellContent]] with serialized content of cells from [[Sheet]], either a cell formula or an explicit value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['0', '=SUM(1, 2, 3)', '=A1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['1', '=TEXT(A2, \"0.0%\")', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['2', '=SUM(A1:C1)', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ];")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" serializedContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetvalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetvalues"}},[t._v("#")]),t._v(" getSheetValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetValues")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L786",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:786"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array of arrays of [[CellValue]] with values of all cells from [[Sheet]].\nApplies rounding and post-processing.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all values of a sheet: [[0, 6, 0], [1, '1.0%', 0], [2, 6, 0]]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddsheet"}},[t._v("#")]),t._v(" isItPossibleToAddSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddSheet")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2534",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2534"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add a sheet to the engine.\nChecks against particular rules to ascertain that addSheet can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addsheet"}},[t._v("addSheet")]),t._v(" operation won't throw any errors, and it is possible to add sheet with provided name.\nReturns "),s("code",[t._v("false")]),t._v(" if the chosen name is already used.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' because 'MySheet2' already exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("sheet name, case-insensitive")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoclearsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoclearsheet"}},[t._v("#")]),t._v(" isItPossibleToClearSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToClearSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2676",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2676"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to clear a specified sheet.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#clearsheet"}},[t._v("clearSheet")]),t._v(" operation won't throw any errors, provided sheet exists and its content can be cleared.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because 'MySheet2' exists and can be cleared")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isClearable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToClearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovesheet"}},[t._v("#")]),t._v(" isItPossibleToRemoveSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2602",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2602"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove sheet for the engine.\nReturns "),s("code",[t._v("true")]),t._v(" if the provided sheet exists, and therefore it can be removed, doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removesheet"}},[t._v("removeSheet")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because sheet with ID 1 exists and is removable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletorenamesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletorenamesheet"}},[t._v("#")]),t._v(" isItPossibleToRenameSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRenameSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3387"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to rename sheet.\nReturns "),s("code",[t._v("true")]),t._v(" if the sheet with provided id exists and new name is available\nReturns "),s("code",[t._v("false")]),t._v(" if sheet cannot be renamed")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRenameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the sheet to be given")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoreplacesheetcontent"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoreplacesheetcontent"}},[t._v("#")]),t._v(" isItPossibleToReplaceSheetContent")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToReplaceSheetContent")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("values")]),t._v(": RawCellContent[][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2748",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2748"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to replace the sheet content.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#setsheetcontent"}},[t._v("setSheetContent")]),t._v(" operation won't throw any errors, the provided sheet exists and then its content can be replaced.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because sheet of ID 0 exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// and the provided content can be placed in this sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isReplaceable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToReplaceSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("values")])]),t._v(" "),s("td",[t._v("RawCellContent[][]")]),t._v(" "),s("td",[t._v("array of new values")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removesheet"}},[t._v("#")]),t._v(" removeSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2645",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2645"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a sheet")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetremoved"}},[t._v("sheetRemoved")]),t._v(" after the sheet was removed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: { error: [CellError], value: '#REF!' },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"renamesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#renamesheet"}},[t._v("#")]),t._v(" renameSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("renameSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newName")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3423",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3423"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Renames a specified sheet.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetrenamed"}},[t._v("sheetRenamed")]),t._v(" after the sheet was renamed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetNameAlreadyTakenError]] when the provided sheet name already exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// renames the sheet 'MySheet1'")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet ID")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the sheet to be given, if is the same as the old one the method does nothing")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setsheetcontent"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setsheetcontent"}},[t._v("#")]),t._v(" setSheetContent")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setSheetContent")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("values")]),t._v(": RawCellContent[][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2785",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2785"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Replaces the sheet content with new values.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when values argument is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("values")])]),t._v(" "),s("td",[t._v("RawCellContent[][]")]),t._v(" "),s("td",[t._v("array of new values")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"ranges"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ranges"}},[t._v("#")]),t._v(" Ranges")]),t._v(" "),s("h3",{attrs:{id:"getfillrangedata"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfillrangedata"}},[t._v("#")]),t._v(" getFillRangeData")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFillRangeData")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("target")]),t._v(": SimpleCellRange, "),s("code",[t._v("offsetsFromTarget")]),t._v(": boolean): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2490",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2490"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns values to fill target range using source range, with properly extending the range using wrap-around heuristic.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source or target are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=$A$1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return [['2', '=$A$1', '2'], ['=A3', 1, '=C3'], ['2', '=$A$1', '2']]")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFillRangeData")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("of data")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("target")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("range where data is intended to be put")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("offsetsFromTarget")])]),t._v(" "),s("td",[t._v("boolean")]),t._v(" "),s("td",[t._v("false")]),t._v(" "),s("td",[t._v("if true, offsets are computed from target corner, otherwise from source corner")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangeformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangeformulas"}},[t._v("#")]),t._v(" getRangeFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeFormulas")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2420",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2420"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns cell formulas in given range.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns cell formulas of a given range only:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ '=SUM(1, 2)', undefined ], [ undefined, undefined ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangeserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangeserialized"}},[t._v("#")]),t._v(" getRangeSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeSerialized")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2456",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2456"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns serialized cells in given range.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized cell content for the given range:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ '=SUM(1, 2)', 2 ], [ 5, 6 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeSerialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangevalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangevalues"}},[t._v("#")]),t._v(" getRangeValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeValues")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2384",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2384"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the cell content of a given range in a [[CellValue]][][] format.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns calculated cells content: [ [ 3, 2 ], [ 5, 6 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rows"}},[t._v("#")]),t._v(" Rows")]),t._v(" "),s("h3",{attrs:{id:"addrows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addrows"}},[t._v("#")]),t._v(" addRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1641",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1641"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds multiple rows into a specified position in a given sheet.\nDoes nothing if rows are outside effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which rows will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddrows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddrows"}},[t._v("#")]),t._v(" isItPossibleToAddRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1599",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1599"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add rows into a specified position in a given sheet.\nChecks against particular rules to ascertain that addRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addrows"}},[t._v("addRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if adding rows would exceed the sheet size limit or given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add one row in the second row of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which rows will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomoverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomoverows"}},[t._v("#")]),t._v(" isItPossibleToMoveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startRow")]),t._v(": number, "),s("code",[t._v("numberOfRows")]),t._v(": number, "),s("code",[t._v("targetRow")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1996",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1996"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move a particular number of rows to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#moverows"}},[t._v("moveRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected rows, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move one row from row 0 into row 2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first row to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfRows")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of rows to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("row number before which rows will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremoverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremoverows"}},[t._v("#")]),t._v(" isItPossibleToRemoveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1672",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1672"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove rows from a specified position in a given sheet.\nChecks against particular rules to ascertain that removeRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removerows"}},[t._v("removeRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to remove one row from row 1 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which rows will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [row, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetroworder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetroworder"}},[t._v("#")]),t._v(" isItPossibleToSetRowOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetRowOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newRowOrder")]),t._v(": number[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1402",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1402"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder rows of a sheet according to a permutation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newRowOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoswaprowindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoswaprowindexes"}},[t._v("#")]),t._v(" isItPossibleToSwapRowIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSwapRowIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("rowMapping")]),t._v(": [number, number][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1323",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1323"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder rows of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSwappable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSwappable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rowMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"moverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moverows"}},[t._v("#")]),t._v(" moveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startRow")]),t._v(": number, "),s("code",[t._v("numberOfRows")]),t._v(": number, "),s("code",[t._v("targetRow")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2043"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves a particular number of rows to a specified position in a given sheet.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first row to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfRows")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of rows to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("row number before which rows will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removerows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removerows"}},[t._v("#")]),t._v(" removeRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1713",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1713"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes multiple rows from a specified position in a given sheet.\nDoes nothing if rows are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return: [{ sheet: 0, col: 1, row: 2, value: null }] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which rows will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [row, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setroworder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setroworder"}},[t._v("#")]),t._v(" setRowOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setRowOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newRowOrder")]),t._v(": number[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1371",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1371"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders rows of a sheet according to a permutation of 0-based indexes.\nParameter "),s("code",[t._v("newRowOrder")]),t._v(" should have a form "),s("code",[t._v("[ newPositionForRow0, newPositionForRow1, newPositionForRow2, ... ]")]),t._v(".\nThis method might be used to "),s("RouterLink",{attrs:{to:"/guide/sorting-data.html"}},[t._v("sort the rows of a sheet")]),t._v(".")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note: This method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'C'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'D'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" newRowOrder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ newPosForA, newPosForB, newPosForC, newPosForD ]")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newRowOrder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sheet after this operation: [['A'], ['D'], ['C'], ['B']]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newRowOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"swaprowindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#swaprowindexes"}},[t._v("#")]),t._v(" swapRowIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("swapRowIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("rowMapping")]),t._v(": [number, number][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1292",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1292"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders rows of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set swap rows 0 and 2 in place, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 2 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 2 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: null,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 4,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 5,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rowMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#columns"}},[t._v("#")]),t._v(" Columns")]),t._v(" "),s("h3",{attrs:{id:"addcolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addcolumns"}},[t._v("#")]),t._v(" addColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1789",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1789"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds multiple columns into a specified position in a given sheet.\nDoes nothing if the columns are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.92754862796338,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which columns will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddcolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddcolumns"}},[t._v("#")]),t._v(" isItPossibleToAddColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1743",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1743"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add columns into a specified position in a given sheet.\nChecks against particular rules to ascertain that addColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addcolumns"}},[t._v("addColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if adding columns would exceed the sheet size limit or given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add 1 column in sheet 0, at column 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which columns will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomovecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomovecolumns"}},[t._v("#")]),t._v(" isItPossibleToMoveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startColumn")]),t._v(": number, "),s("code",[t._v("numberOfColumns")]),t._v(": number, "),s("code",[t._v("targetColumn")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2078",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2078"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move a particular number of columns to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecolumns"}},[t._v("moveColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move one column from column 1 into column 2 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first column to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfColumns")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of columns to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("column number before which columns will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovecolumns"}},[t._v("#")]),t._v(" isItPossibleToRemoveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1819",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1819"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove columns from a specified position in a given sheet.\nChecks against particular rules to ascertain that removeColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removecolumns"}},[t._v("removeColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to remove one column, in place of the second column of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which columns will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [column, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetcolumnorder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetcolumnorder"}},[t._v("#")]),t._v(" isItPossibleToSetColumnOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetColumnOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newColumnOrder")]),t._v(": number[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1563",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1563"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder columns of a sheet according to a permutation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newColumnOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoswapcolumnindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoswapcolumnindexes"}},[t._v("#")]),t._v(" isItPossibleToSwapColumnIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSwapColumnIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("columnMapping")]),t._v(": [number, number][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1488",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1488"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder columns of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("columnMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"movecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#movecolumns"}},[t._v("#")]),t._v(" moveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startColumn")]),t._v(": number, "),s("code",[t._v("numberOfColumns")]),t._v(": number, "),s("code",[t._v("targetColumn")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2131",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2131"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves a particular number of columns to a specified position in a given sheet.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.16210054671639,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }, {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 4, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 6.16210054671639,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first column to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfColumns")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of columns to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("column number before which columns will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removecolumns"}},[t._v("#")]),t._v(" removeColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1864"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes multiple columns from a specified position in a given sheet.\nDoes nothing if columns are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: { error: [CellError], value: '#REF!' },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which columns will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setcolumnorder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setcolumnorder"}},[t._v("#")]),t._v(" setColumnOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setColumnOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newColumnOrder")]),t._v(": number[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1533",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1533"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders columns of a sheet according to a permutation of 0-based indexes.\nParameter "),s("code",[t._v("newColumnOrder")]),t._v(" should have a form "),s("code",[t._v("[ newPositionForColumn0, newPositionForColumn1, newPositionForColumn2, ... ]")]),t._v(".\nThis method might be used to "),s("RouterLink",{attrs:{to:"/guide/sorting-data.html"}},[t._v("sort the columns of a sheet")]),t._v(".")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note: This method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'C'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'D'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" newColumnOrder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ newPosForA, newPosForB, newPosForC, newPosForD ]")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newColumnOrder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sheet after this operation: [['A', 'D', 'C', 'B']]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newColumnOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"swapcolumnindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#swapcolumnindexes"}},[t._v("#")]),t._v(" swapColumnIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("swapColumnIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("columnMapping")]),t._v(": [number, number][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1460",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1460"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders columns of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set swap columns 0 and 2 in place, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 2, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 2, row: 1 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 5,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 4,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 1 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: null,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("columnMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cells"}},[t._v("#")]),t._v(" Cells")]),t._v(" "),s("h3",{attrs:{id:"doescellhaveformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doescellhaveformula"}},[t._v("#")]),t._v(" doesCellHaveFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesCellHaveFormula")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3175",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3175"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if the specified cell contains a formula.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since the A1 cell contains a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' since the B1 cell does not contain a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1NoFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"doescellhavesimplevalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doescellhavesimplevalue"}},[t._v("#")]),t._v(" doesCellHaveSimpleValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesCellHaveSimpleValue")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3144",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3144"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if the specified cell contains a simple value.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since the selected cell contains a simple value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isA1Simple "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveSimpleValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' since the selected cell does not contain a simple value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isB1Simple "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveSimpleValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellformula"}},[t._v("#")]),t._v(" getCellFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellFormula")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L692",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:692"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a normalized formula string from the cell of a given address or "),s("code",[t._v("undefined")]),t._v(" for an address that does not exist and empty values.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a normalized A1 cell formula: '=SUM(1, 2, 3)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a normalized B1 cell formula: 'undefined'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellhyperlink"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellhyperlink"}},[t._v("#")]),t._v(" getCellHyperlink")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellHyperlink")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:722"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the "),s("code",[t._v("HYPERLINK")]),t._v(" url for a cell of a given address or "),s("code",[t._v("undefined")]),t._v(" for an address that does not exist or a cell that is not "),s("code",[t._v("HYPERLINK")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('\'=HYPERLINK("https://hyperformula.handsontable.com/", "HyperFormula")\'')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return url of 'HYPERLINK': https://hyperformula.handsontable.com/")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Hyperlink "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellHyperlink")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'undefined' for a cell that is not 'HYPERLINK'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Hyperlink "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellHyperlink")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellserialized"}},[t._v("#")]),t._v(" getCellSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellSerialized")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("RawCellContent")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L754",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:754"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns [[RawCellContent]] with a serialized content of the cell of a given address: either a cell formula, an explicit value, or an error.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized content of A1 cell: '=SUM(1, 2, 3)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellA1Serialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized content of B1 cell: '0'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellB1Serialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcelltype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcelltype"}},[t._v("#")]),t._v(" getCellType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3112",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3112"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the type of a cell at a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'FORMULA', the cell of given coordinates is of this type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellA1Type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'VALUE', the cell of given coordinates is of this type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellB1Type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvalue"}},[t._v("#")]),t._v(" getCellValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValue")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValue")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L661",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:661"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the cell value of a given address.\nApplies rounding and post-processing.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get value of A1 cell, should be '6'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get value of B1 cell, should be '2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvaluedetailedtype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvaluedetailedtype"}},[t._v("#")]),t._v(" getCellValueDetailedType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueDetailedType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValueDetailedType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3302",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3302"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns detailed type of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1%'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1$'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER_PERCENT', cell value type of provided coordinates is a number with a format inference percent.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellType "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueDetailedType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER_CURRENCY', cell value type of provided coordinates is a number with a format inference currency.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellType "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueDetailedType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValueDetailedType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvalueformat"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvalueformat"}},[t._v("#")]),t._v(" getCellValueFormat")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueFormat")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("FormatInfo")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3336",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3336"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns auxiliary format information of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1$'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return '$', cell value type of provided coordinates is a number with a format inference currency, parsed as using '$' as currency.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellFormat "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return undefined, cell value type of provided coordinates is a number with no format information.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellFormat "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FormatInfo")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvaluetype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvaluetype"}},[t._v("#")]),t._v(" getCellValueType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValueType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3268",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3268"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns type of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER', cell value type of provided coordinates is a number")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER', cell value type of provided coordinates is a number")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValueType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"iscellempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#iscellempty"}},[t._v("#")]),t._v(" isCellEmpty")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isCellEmpty")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3207",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3207"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns"),s("code",[t._v("true")]),t._v(" if the specified cell is empty.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', cell of provided coordinates is empty")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false', cell of provided coordinates is not empty")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isNotEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"iscellpartofarray"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#iscellpartofarray"}},[t._v("#")]),t._v(" isCellPartOfArray")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isCellPartOfArray")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3235",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3235"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if a given cell is a part of an array.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{=TRANSPOSE(B1:B1)}'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', cell of provided coordinates is a part of an array")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isPartOfArray "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellPartOfArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomovecells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomovecells"}},[t._v("#")]),t._v(" isItPossibleToMoveCells")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveCells")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("destinationLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1900",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1900"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move cells to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveCells can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if destinationLeftCorner, source, or any of basic type arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the coordinates and assign them to variables")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move a block of width 1 and height 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// from the corner: column 1 and row 0 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// into destination corner: column 3, row 0 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("range for a moved block")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("destinationLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetcellcontents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetcellcontents"}},[t._v("#")]),t._v(" isItPossibleToSetCellContents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetCellContents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1187",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1187"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to change the content in a rectangular area bounded by the box.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#setcellcontents"}},[t._v("setCellContents")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the address is invalid or the sheet does not exist.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// top left corner")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address1 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// bottom right corner")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address2 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example, it is possible to set content of")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// width 2, height 1 in the first row and column of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSettable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address1"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address2 "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("single cell or block of cells to check")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"movecells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#movecells"}},[t._v("#")]),t._v(" moveCells")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveCells")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("destinationLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1957",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1957"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves the content of a cell block from source to the target location.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if destinationLeftCorner or source are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the coordinates and assign them to variables")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.93524248002062,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("range for a moved block")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("destinationLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setcellcontents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setcellcontents"}},[t._v("#")]),t._v(" setCellContents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setCellContents")]),t._v("("),s("code",[t._v("topLeftCornerAddress")]),t._v(": SimpleCellAddress, "),s("code",[t._v("cellContents")]),t._v(": RawCellContent[][] | RawCellContent): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1240",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1240"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Sets the content for a block of cells of a given coordinates.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the value is not an array of arrays or a raw cell value")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if topLeftCornerAddress argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set the content, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 3, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 2,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("topLeftCornerAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("top left corner of block of cells")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("cellContents")])]),t._v(" "),s("td",[t._v("RawCellContent[][] | RawCellContent")]),t._v(" "),s("td",[t._v("array with content")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"named-expressions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#named-expressions"}},[t._v("#")]),t._v(" Named Expressions")]),t._v(" "),s("h3",{attrs:{id:"addnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addnamedexpression"}},[t._v("#")]),t._v(" addNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("expression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number, "),s("code",[t._v("options?")]),t._v(": NamedExpressionOptions): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3653",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3653"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a specified named expression.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#namedexpressionadded"}},[t._v("namedExpressionAdded")]),t._v(" always, unless "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#batch"}},[t._v("batch")]),t._v(" mode is used")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionNameIsAlreadyTakenError]] when the named-expression name is not available.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionNameIsInvalidError]] when the named-expression name is not valid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoRelativeAddressesAllowedError]] when the named-expression formula contains relative references")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add own expression, scope limited to 'Sheet1' (sheetId=0), the method should return a list of cells which values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// changed after the operation, their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// name: 'prettyName',")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 142,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the expression to be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("expression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("the expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("options?")])]),t._v(" "),s("td",[t._v("NamedExpressionOptions")]),t._v(" "),s("td",[t._v("additional metadata related to named expression")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"changenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#changenamedexpression"}},[t._v("#")]),t._v(" changeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("changeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("newExpression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number, "),s("code",[t._v("options?")]),t._v(": NamedExpressionOptions): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3869",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3869"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Changes a given named expression to a specified formula.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionDoesNotExistError]] when the given expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ArrayFormulasNotSupportedError]] when the named expression formula is an array formula")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoRelativeAddressesAllowedError]] when the named expression formula contains relative references")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression, scope limited to 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// change the named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("changeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+200'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newExpression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("a new expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("options?")])]),t._v(" "),s("td",[t._v("NamedExpressionOptions")]),t._v(" "),s("td",[t._v("additional metadata related to named expression")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallnamedexpressionsserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallnamedexpressionsserialized"}},[t._v("#")]),t._v(" getAllNamedExpressionsSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllNamedExpressionsSerialized")]),t._v("(): "),s("em",[t._v("SerializedNamedExpression[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4033",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4033"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all named expressions serialized.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add two named expressions and one scoped")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'anotherPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$2+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$3+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get all expressions serialized")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'prettyName', expression: '=Sheet1!$A$1+100', options: undefined, scope: undefined},")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'anotherPrettyName', expression: '=Sheet1!$A$2+100', options: undefined, scope: undefined},")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'alsoPrettyName', expression: '=Sheet1!$A$3+100', options: undefined, scope: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllNamedExpressionsSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SerializedNamedExpression[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpression"}},[t._v("#")]),t._v(" getNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("NamedExpression | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3772",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3772"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a named expression, or "),s("code",[t._v("undefined")]),t._v(" for a named expression that does not exist or does not hold a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression in 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a named expression that corresponds to the passed name from 'Sheet1' (sheetId=0)")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'prettyName', expression: '=Sheet1!$A$1+100', options: undefined, scope: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for a named expression that doesn't exist, returns 'undefined':")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormulaTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("NamedExpression | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionformula"}},[t._v("#")]),t._v(" getNamedExpressionFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionFormula")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3729",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3729"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a normalized formula string for given named expression, or "),s("code",[t._v("undefined")]),t._v(" for a named expression that does not exist or does not hold a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression in 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a normalized formula string corresponding to the passed name from 'Sheet1' (sheetId=0),")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// '=Sheet1!A1+100' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionvalue"}},[t._v("#")]),t._v(" getNamedExpressionValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionValue")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("CellValue | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3689",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3689"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Gets specified named expression value.\nReturns a [[CellValue]] or undefined if the given named expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression, only 'Sheet1' (sheetId=0) considered as it is the scope")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the calculated value of a passed named expression, '142' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddnamedexpression"}},[t._v("#")]),t._v(" isItPossibleToAddNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("expression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3601",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3601"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add named expression into a specific scope.\nChecks against particular rules to ascertain that addNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addnamedexpression"}},[t._v("addNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add named expression to global scope")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the expression to be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("expression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("the expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletochangenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletochangenamedexpression"}},[t._v("#")]),t._v(" isItPossibleToChangeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToChangeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("newExpression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3821",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3821"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to change named expression in a specific scope.\nChecks against particular rules to ascertain that changeNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#changenamedexpression"}},[t._v("changeNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to change named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToChangeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newExpression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("a new expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovenamedexpression"}},[t._v("#")]),t._v(" isItPossibleToRemoveNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3905",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3905"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove named expression from a specific scope.\nChecks against particular rules to ascertain that removeNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removenamedexpression"}},[t._v("removeNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to change named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"listnamedexpressions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listnamedexpressions"}},[t._v("#")]),t._v(" listNamedExpressions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("listNamedExpressions")]),t._v("("),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3997",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3997"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Lists named expressions.")]),t._v(" "),s("ul",[s("li",[t._v("If scope parameter is provided, returns an array of expression names defined for this scope.")]),t._v(" "),s("li",[t._v("If scope parameter is undefined, returns an array of global expression names.")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add two named expressions and one scoped")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'anotherPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$2+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'alsoPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$3+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// list the expressions, should return: ['prettyName', 'anotherPrettyName'] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" listOfExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listNamedExpressions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// list the expressions, should return: ['alsoPrettyName'] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" listOfExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listNamedExpressions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope of the named expressions, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removenamedexpression"}},[t._v("#")]),t._v(" removeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3950",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3950"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a named expression.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#namedexpressionremoved"}},[t._v("namedExpressionRemoved")]),t._v(" after the expression was removed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionDoesNotExistError]] when the given expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove the named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"helpers"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#helpers"}},[t._v("#")]),t._v(" Helpers")]),t._v(" "),s("h3",{attrs:{id:"calculateformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#calculateformula"}},[t._v("#")]),t._v(" calculateFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("calculateFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("CellValue | CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4098",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4098"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Calculates fire-and-forget formula, returns the calculated value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with "),s("code",[t._v("=")]),t._v(").")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the provided "),s("code",[t._v("sheetID")]),t._v(" doesn't exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'58'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the calculated formula's value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns `68`")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" calculatedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("calculateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns [['11', '12', '13'], ['14', '15', '16']]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" calculatedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("calculateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1:B3+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("A formula in a proper format, starting with "),s("code",[t._v("=")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("The ID of a sheet in context of which the formula gets evaluated.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue | CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcelldependents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcelldependents"}},[t._v("#")]),t._v(" getCellDependents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellDependents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2939",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2939"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all the out-neighbors in the "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html"}},[t._v("dependency graph")]),t._v(" for a given cell address or range. Including:")],1),t._v(" "),s("ul",[s("li",[t._v("All cells with formulas that contain the given cell address or range")]),t._v(" "),s("li",[t._v("Some of the ranges that contain the given cell address or range")])]),t._v(" "),s("p",[t._v("The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html#optimizations-for-large-ranges"}},[t._v('"Optimizations for large ranges"')]),t._v(".")],1),t._v(" "),s("p",[t._v("The returned array includes also named expression dependents. They are represented as cell references with sheet ID "),s("code",[t._v("-1")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellDependents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns [{ sheet: 0, col: 1, row: 0}, { sheet: 0, col: 2, row: 0}]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute address or range of addresses")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellprecedents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellprecedents"}},[t._v("#")]),t._v(" getCellPrecedents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellPrecedents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2977",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2977"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all the in-neighbors in the "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html"}},[t._v("dependency graph")]),t._v(" for a given cell address or range. In particular:")],1),t._v(" "),s("ul",[s("li",[t._v("If the argument is a single cell, "),s("code",[t._v("getCellPrecedents()")]),t._v(" returns all cells and ranges contained in that cell's formula.")]),t._v(" "),s("li",[t._v("If the argument is a range of cells, "),s("code",[t._v("getCellPrecedents()")]),t._v(" returns some of the cell addresses and smaller ranges contained in that range (but not all of them). The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html#optimizations-for-large-ranges"}},[t._v('"Optimizations for large ranges"')]),t._v(".")],1)]),t._v(" "),s("p",[t._v("The returned array includes also named expression precedents. They are represented as cell references with sheet ID "),s("code",[t._v("-1")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if address is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellPrecedents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns [{ sheet: 0, col: 0, row: 0}, { sheet: 0, col: 1, row: 0}]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute address or range of addresses")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionsfromformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionsfromformula"}},[t._v("#")]),t._v(" getNamedExpressionsFromFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionsFromFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4129",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4129"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Return a list of named expressions used by a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with "),s("code",[t._v("=")]),t._v(").")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a list of named expressions used by a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns ['foo', 'bar']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" namedExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionsFromFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=foo+bar*2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("A formula in a proper format, starting with "),s("code",[t._v("=")]),t._v(".")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"normalizeformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#normalizeformula"}},[t._v("#")]),t._v(" normalizeFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("normalizeFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4062",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4062"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Parses and then unparses a formula.\nReturns a normalized formula (e.g., restores the original capitalization of sheet names, function names, cell addresses, and named expressions).")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(' [[NotAFormulaError]] when the provided string is not a valid formula, i.e., does not start with "="')]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns '=Sheet1!$A$1+10'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" normalizedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("normalizeFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SHEET1!$A$1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns '=3*$A$1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" normalizedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("normalizeFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=3*$a$1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v('a formula in a proper format - it must start with "="')])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertodate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertodate"}},[t._v("#")]),t._v(" numberToDate")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToDate")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4278",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4278"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a date.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass the number of days since nullDate")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the method should return formatted date, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {year: 2020, month: 1, day: 15}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dateFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("43845")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of days since nullDate, should be non-negative, fractions are ignored.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertodatetime"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertodatetime"}},[t._v("#")]),t._v(" numberToDateTime")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToDateTime")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4254",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4254"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a date + time.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass the number of days since nullDate")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the method should return formatted date and time, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {year: 2020, month: 1, day: 15, hours: 2, minutes: 24, seconds: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dateTimeFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToDateTime")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("43845.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertotime"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertotime"}},[t._v("#")]),t._v(" numberToTime")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToTime")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4301",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4301"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a time (hours/minutes/seconds).")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass a number to be interpreted as a time")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return {hours: 26, minutes: 24} for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" timeFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToTime")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("time in 24h units.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecelladdressfromstring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecelladdressfromstring"}},[t._v("#")]),t._v(" simpleCellAddressFromString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellAddressFromString")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": string, "),s("code",[t._v("contextSheetId")]),t._v(": number): "),s("em",[t._v("SimpleCellAddress | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2821",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2821"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes the simple (absolute) address of a cell address, based on its string representation.")]),t._v(" "),s("ul",[s("li",[t._v("If a sheet name is present in the string representation but is not present in the engine, returns "),s("code",[t._v("undefined")]),t._v(".")]),t._v(" "),s("li",[t._v("If no sheet name is present in the string representation, returns "),s("code",[t._v("contextSheetId")]),t._v(" as sheet number.")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 0 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 5 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1!A6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 5 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1!$A$6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns 'undefined', as there's no 'Sheet 2' in the HyperFormula instance")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet2!A6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("string representation of cell address in A1 notation")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("contextSheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SimpleCellAddress | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecelladdresstostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecelladdresstostring"}},[t._v("#")]),t._v(" simpleCellAddressToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellAddressToString")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2873",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2873"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns string representation of an absolute address in A1 notation or "),s("code",[t._v("undefined")]),t._v(" if the sheet index is not present in the engine.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if its arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'B2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Notation "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("object representation of an absolute address")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecellrangefromstring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecellrangefromstring"}},[t._v("#")]),t._v(" simpleCellRangeFromString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellRangeFromString")]),t._v("("),s("code",[t._v("cellRange")]),t._v(": string, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("SimpleCellRange | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2848",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2848"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes simple (absolute) address of a cell range based on its string representation.\nIf sheet name is present in string representation but not present in the engine, returns "),s("code",[t._v("undefined")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return { start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 0 } }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1:A2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellRange")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("string representation of cell range in A1 notation")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SimpleCellRange | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecellrangetostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecellrangetostring"}},[t._v("#")]),t._v(" simpleCellRangeToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellRangeToString")]),t._v("("),s("code",[t._v("cellRange")]),t._v(": SimpleCellRange, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2906",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2906"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns string representation of an absolute range in A1 notation or "),s("code",[t._v("undefined")]),t._v(" if the sheet index is not present in the engine.")]),t._v(" "),s("p",[t._v("Note: This method is useful only for cell ranges; does not work with column ranges and row ranges.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if its arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 1")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'B2:C2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Notation "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'Sheet1!B2:C2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" another "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellRange")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute range")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"validateformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#validateformula"}},[t._v("#")]),t._v(" validateFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("validateFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4163",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4163"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v('Validates the formula.\nIf the provided string starts with "=" and is a parsable formula, the method returns '),s("code",[t._v("true")]),t._v(".\nThe validation is purely grammatical: the method doesn't verify if the formula can be calculated or not.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// checks if the given string is a valid formula, should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("validateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v('a formula in a proper format - it must start with "="')])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"clipboard"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clipboard"}},[t._v("#")]),t._v(" Clipboard")]),t._v(" "),s("h3",{attrs:{id:"clearclipboard"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearclipboard"}},[t._v("#")]),t._v(" clearClipboard")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearClipboard")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2303",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2303"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the clipboard content.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clears the clipboard, isClipboardEmpty() should return true if called afterwards")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearClipboard")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"copy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#copy"}},[t._v("#")]),t._v(" copy")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("copy")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2167",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2167"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Stores a copy of the cell block in internal clipboard for the further paste.\nReturns the copied values for use in external clipboard.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it copies [ [ 2 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangle range to copy")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"cut"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cut"}},[t._v("#")]),t._v(" cut")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("cut")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2205",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2205"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Stores information of the cell block in internal clipboard for further paste.\nCalling "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#paste"}},[t._v("paste")]),t._v(" right after this method is equivalent to call "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(".\nAlmost any CRUD operation called after this method will abort the cut operation.\nReturns the cut values for use in external clipboard.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the values that were cut: [ [ 1 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("cut")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangle range to cut")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isclipboardempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isclipboardempty"}},[t._v("#")]),t._v(" isClipboardEmpty")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isClipboardEmpty")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2286",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2286"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether there is something in the clipboard.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// copy desired content")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns 'false', there is content in the clipboard")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isClipboardEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isClipboardEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"paste"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#paste"}},[t._v("#")]),t._v(" paste")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("paste")]),t._v("("),s("code",[t._v("targetLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2254",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2254"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("When called after "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#copy"}},[t._v("copy")]),t._v(" it pastes copied values and formulas into a cell block.\nWhen called after "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#cut"}},[t._v("cut")]),t._v(" it performs "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(" operation into the cell block.\nDoes nothing if the clipboard is empty.")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NothingToPasteError]] when clipboard is empty")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the selected target area has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if targetLeftCorner is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ 2 ] ] was copied")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a list of modified cells: their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("paste")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("targetLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"undo-and-redo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#undo-and-redo"}},[t._v("#")]),t._v(" Undo and Redo")]),t._v(" "),s("h3",{attrs:{id:"clearredostack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearredostack"}},[t._v("#")]),t._v(" clearRedoStack")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearRedoStack")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2331",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2331"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the redo stack in undoRedo history.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do an operation, for example remove columns")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// redo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("redo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the redo stack")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearRedoStack")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"clearundostack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearundostack"}},[t._v("#")]),t._v(" clearUndoStack")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearUndoStack")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L2356",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2356"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the undo stack in undoRedo history.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do an operation, for example remove columns")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the undo stack")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearUndoStack")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"istheresomethingtoredo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#istheresomethingtoredo"}},[t._v("#")]),t._v(" isThereSomethingToRedo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isThereSomethingToRedo")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1155",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1155"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if there is at least one operation that can be re-done.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// when there is an action to redo, this returns 'true'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSomethingToRedo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isThereSomethingToRedo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"istheresomethingtoundo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#istheresomethingtoundo"}},[t._v("#")]),t._v(" isThereSomethingToUndo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isThereSomethingToUndo")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1138",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1138"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if there is at least one operation that can be undone.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', it is possible to undo last operation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// which is removing rows in this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSomethingToUndo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isThereSomethingToUndo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"redo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#redo"}},[t._v("#")]),t._v(" redo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("redo")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1112",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1112"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Re-do recently undone operation.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoOperationToRedoError]] when there is no operation running that can be re-done")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation, it should return previous values: [['1'], ['2'], ['3']]")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do a redo, it should return the values after removing the second row: [['1'], ['3']]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("redo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"undo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#undo"}},[t._v("#")]),t._v(" undo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("undo")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L1076",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1076"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Undo the previous operation.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoOperationToUndoError]] when there is no operation running that can be undone")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation, it should return the changes")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"batch"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch"}},[t._v("#")]),t._v(" Batch")]),t._v(" "),s("h3",{attrs:{id:"batch-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch-2"}},[t._v("#")]),t._v(" batch")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("batch")]),t._v("("),s("code",[t._v("batchOperations")]),t._v(": function): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3463",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3463"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Runs the provided callback as a single "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch operation")]),t._v(" and returns the changed cells.")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of all batched operations")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationsuspended"}},[t._v("evaluationSuspended")]),t._v(" always")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationresumed"}},[t._v("evaluationResumed")]),t._v(" after the recomputation of necessary values")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// multiple operations in a single callback will trigger evaluation only once")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// and only one set of changes is returned as a combined result of all")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the operations that were triggered within the callback")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("batch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("batchOperations")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[t._v("a function with operations to be performed")]),t._v(" "),s("p",[t._v("▸ (): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isevaluationsuspended"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isevaluationsuspended"}},[t._v("#")]),t._v(" isEvaluationSuspended")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isEvaluationSuspended")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3572",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3572"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if the dependency graph recalculation process is "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("suspended")]),t._v(" or not.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend the evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// between suspendEvaluation() and resumeEvaluation()")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or inside batch() callback it will return 'true', otherwise 'false'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isEvaluationSuspended "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isEvaluationSuspended")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"resumeevaluation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#resumeevaluation"}},[t._v("#")]),t._v(" resumeEvaluation")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("resumeEvaluation")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3546",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3546"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Resumes the dependency graph recalculation that was "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("suspended")]),t._v(" with "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#suspendevaluation"}},[t._v("suspendEvaluation")]),t._v(".\nIt also triggers the recalculation and returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of all batched operations")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationresumed"}},[t._v("evaluationResumed")]),t._v(" after the recomputation of necessary values")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// similar to batch() but operations are not within a callback,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one method suspends the recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the second will resume calculations and return the changes")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first, suspend the evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform operations")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume the evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"suspendevaluation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#suspendevaluation"}},[t._v("#")]),t._v(" suspendEvaluation")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("suspendEvaluation")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L3510",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3510"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Suspends the dependency graph recalculation to start a "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch operation")]),t._v(".\nIt allows optimizing the performance.\nWith this method, multiple CRUD operations can be done without triggering recalculation after every operation.\nSuspending evaluation should result in an overall faster calculation compared to recalculating after each operation separately.\nTo resume the evaluation use "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#resumeevaluation"}},[t._v("resumeEvaluation")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationsuspended"}},[t._v("evaluationSuspended")]),t._v(" always")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// similar to batch() but operations are not within a callback,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one method suspends the recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the second will resume calculations and return the changes")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend the evaluation with this method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform operations")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use resumeEvaluation to resume")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"events"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" Events")]),t._v(" "),s("h3",{attrs:{id:"off"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("off")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4387"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unsubscribes from an event or from all events.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a simple function to be called upon emitting an event")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger an event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'baz' each time a sheet is added")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from a 'sheetAdded'")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet, the console should not print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"on"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("on")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4327",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4327"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Subscribes to an event.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass a simple handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'foo'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger an event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'foo' after each time sheet is added in this example")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"once"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("once")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4353",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4353"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Subscribes to an event once.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass a simple handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'foo'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// call addSheet twice,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'foo' only once when the sheet is added in this example")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"custom-functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-functions"}},[t._v("#")]),t._v(" Custom Functions")]),t._v(" "),s("h3",{attrs:{id:"getallfunctionplugins"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallfunctionplugins"}},[t._v("#")]),t._v(" getAllFunctionPlugins")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllFunctionPlugins")]),t._v("(): "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4230",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4230"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns classes of all plugins registered in this instance of HyperFormula")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return classes of all plugins registered, assign to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllFunctionPlugins")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfunctionplugin"}},[t._v("#")]),t._v(" getFunctionPlugin")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFunctionPlugin")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4212",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4212"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns class of a plugin used by function with given id")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myPlugin "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("id of a function, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredfunctionnames"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredfunctionnames"}},[t._v("#")]),t._v(" getRegisteredFunctionNames")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredFunctionNames")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L4184",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4184"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns translated names of all functions registered in this instance of HyperFormula\naccording to the language set in the configuration")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return translated names of all functions, assign to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredFunctionNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"static-methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-methods"}},[t._v("#")]),t._v(" Static Methods")]),t._v(" "),s("h3",{attrs:{id:"getallfunctionplugins-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallfunctionplugins-2"}},[t._v("#")]),t._v(" getAllFunctionPlugins "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllFunctionPlugins")]),t._v("(): "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:613"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns classes of all plugins registered in HyperFormula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return classes of all plugins")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allClasses "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllFunctionPlugins")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getfunctionplugin-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfunctionplugin-2"}},[t._v("#")]),t._v(" getFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFunctionPlugin")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:597"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns class of a plugin used by function with given id")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return the class of a given plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFunctionClass "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("id of a function, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getlanguage"}},[t._v("#")]),t._v(" getLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string): "),s("em",[t._v("TranslationPackage")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L348",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:348"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns registered language from its code string.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageNotRegisteredError]] when trying to retrieve not registered language")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return registered language")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" language "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enGB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("TranslationPackage")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredfunctionnames-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredfunctionnames-2"}},[t._v("#")]),t._v(" getRegisteredFunctionNames "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredFunctionNames")]),t._v("("),s("code",[t._v("code")]),t._v(": string): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L569",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:569"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns translated names of all registered functions for a given language")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return a list of function names registered for enGB")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredFunctionNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enGB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("code")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("language code")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredlanguagescodes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredlanguagescodes"}},[t._v("#")]),t._v(" getRegisteredLanguagesCodes "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredLanguagesCodes")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:427"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all registered languages codes.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all registered language codes: ['enGB', 'plPL']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" registeredLanguages "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredLanguagesCodes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerfunction"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerfunction"}},[t._v("#")]),t._v(" registerFunction "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerFunction")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string, "),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition, "),s("code",[t._v("translations?")]),t._v(": FunctionTranslationsPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L505",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:505"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers a function with a given id if such exists in a plugin.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("function id, e.g., 'SUMIF'")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("translations?")])]),t._v(" "),s("td",[t._v("FunctionTranslationsPackage")]),t._v(" "),s("td",[t._v("translations for the function name")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerfunctionplugin"}},[t._v("#")]),t._v(" registerFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerFunctionPlugin")]),t._v("("),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition, "),s("code",[t._v("translations?")]),t._v(": FunctionTranslationsPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L455",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:455"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers all functions in a given plugin with optional translations.")]),t._v(" "),s("p",[t._v("Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used.\nHyperFormula instances created prior to the registration of a FunctionPlugin are unable to access the FunctionPlugin.\nRegistering a FunctionPlugin with [[custom-functions]] requires the translations parameter.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register the plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("translations?")])]),t._v(" "),s("td",[t._v("FunctionTranslationsPackage")]),t._v(" "),s("td",[t._v("optional package of function names translations")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerlanguage"}},[t._v("#")]),t._v(" registerLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string, "),s("code",[t._v("languagePackage")]),t._v(": RawTranslationPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L379",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:379"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers language under given code string.")]),t._v(" "),s("p",[t._v("For more information, see the "),s("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[t._v("Localizing functions guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageAlreadyRegisteredError]] when given language is already registered")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return registered language")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enUS'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" enUS"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" engine "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("language")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enUS'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("languagePackage")])]),t._v(" "),s("td",[t._v("RawTranslationPackage")]),t._v(" "),s("td",[t._v("translation package to be registered")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterallfunctions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterallfunctions"}},[t._v("#")]),t._v(" unregisterAllFunctions "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterAllFunctions")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L550",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:550"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears function registry.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterAllFunctions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterfunction"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterfunction"}},[t._v("#")]),t._v(" unregisterFunction "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterFunction")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L533",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:533"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters a function with a given id.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("function id, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterfunctionplugin"}},[t._v("#")]),t._v(" unregisterFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterFunctionPlugin")]),t._v("("),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:477"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters all functions defined in given plugin.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the class of a plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" registeredPluginClass "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister all functions defined in a plugin of ID 'EXAMPLE'")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("registeredPluginClass"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterlanguage"}},[t._v("#")]),t._v(" unregisterLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/HyperFormula.ts#L407",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:407"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters language that is registered under given code string.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageNotRegisteredError]] when given language is not registered")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register the language for the instance")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'plPL'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" plPL"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister plPL")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'plPL'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{320:function(t,s,e){"use strict";e.r(s);var a=e(14),n=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"hyperformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula"}},[t._v("#")]),t._v(" HyperFormula "),s("Badge",{attrs:{text:"Class"}})],1),t._v(" "),s("p",[t._v("This is a class for creating HyperFormula instance, all the following public methods\nare related to this class.")]),t._v(" "),s("p",[t._v("The instance can be created only by calling one of the static methods\n"),s("code",[t._v("buildFromArray")]),t._v(", "),s("code",[t._v("buildFromSheets")]),t._v(" or "),s("code",[t._v("buildEmpty")]),t._v(" and should be disposed of with the\n"),s("code",[t._v("destroy")]),t._v(" method when it's no longer needed to free the resources.")]),t._v(" "),s("p",[t._v("The instance can be seen as a workbook where worksheets can be created and\nmanipulated. They are organized within a widely known structure of columns and rows\nwhich can be manipulated as well. The smallest possible data unit are the cells, which\nmay contain simple values or formulas to be calculated.")]),t._v(" "),s("p",[t._v("All CRUD methods are called directly on HyperFormula instance and will trigger\ncorresponding lifecycle events. The events are marked accordingly, as well as thrown\nerrors, so they can be correctly handled.")]),t._v(" "),s("h2",{attrs:{id:"static-properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-properties"}},[t._v("#")]),t._v(" Static Properties")]),t._v(" "),s("h3",{attrs:{id:"builddate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#builddate"}},[t._v("#")]),t._v(" buildDate "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("buildDate")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '20/06/2024 10:19:30'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:101"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Latest build date.")]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"languages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#languages"}},[t._v("#")]),t._v(" languages "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("languages")]),t._v(": "),s("em",[t._v("Record‹string, RawTranslationPackage›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:117"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("When using the UMD build, this property contains all available languages to use with the "),s("a",{attrs:{href:"#registerlanguage"}},[t._v("registerLanguage")]),t._v(" method.")]),t._v(" "),s("p",[t._v("For more information, see the "),s("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[t._v("Localizing functions")]),t._v(" guide.")],1),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"releasedate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#releasedate"}},[t._v("#")]),t._v(" releaseDate "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("releaseDate")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '10/04/2024'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L108",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:108"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("A release date.")]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"version"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#version"}},[t._v("#")]),t._v(" version "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("version")]),t._v(": "),s("em",[t._v("string")]),t._v(" = '2.7.0'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:94"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Version of the HyperFormula.")]),t._v(" "),s("h2",{attrs:{id:"static-accessors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-accessors"}},[t._v("#")]),t._v(" Static Accessors")]),t._v(" "),s("h3",{attrs:{id:"defaultconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#defaultconfig"}},[t._v("#")]),t._v(" defaultConfig "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("get defaultConfig")]),t._v("(): "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:156"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all of HyperFormula's default "),s("RouterLink",{attrs:{to:"/guide/configuration-options.html"}},[t._v("configuration options")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns all default configuration options")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" defaultConfig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaultConfig"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[s("code",[t._v("category")])]),t._v(" Static Accessors")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("h2",{attrs:{id:"factories"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#factories"}},[t._v("#")]),t._v(" Factories")]),t._v(" "),s("h3",{attrs:{id:"buildempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildempty"}},[t._v("#")]),t._v(" buildEmpty "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildEmpty")]),t._v("("),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L328",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:328"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds an empty engine instance.\nCan be configured with the optional parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// build with no initial data and with optional config parameter maxColumns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"buildfromarray"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildfromarray"}},[t._v("#")]),t._v(" buildFromArray "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildFromArray")]),t._v("("),s("code",[t._v("sheet")]),t._v(": Sheet, "),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L268",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:268"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds the engine for a sheet from a two-dimensional array representation.\nThe engine is created with a single sheet.\nCan be configured with the optional second parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified, the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when sheet size exceeds the limits")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when sheet is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// data represented as an array")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'52'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'91'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// method with optional config parameter maxColumns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheet")])]),t._v(" "),s("td",[t._v("Sheet")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("two-dimensional array representation of sheet")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"buildfromsheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#buildfromsheets"}},[t._v("#")]),t._v(" buildFromSheets "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("buildFromSheets")]),t._v("("),s("code",[t._v("sheets")]),t._v(": Sheets, "),s("code",[t._v("configInput")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›, "),s("code",[t._v("namedExpressions")]),t._v(": SerializedNamedExpression[]): "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L308",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:308"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Builds the engine from an object containing multiple sheets with names.\nThe engine is created with one or more sheets.\nCan be configured with the optional second parameter that represents a "),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v(".\nIf not specified the engine will be built with the default configuration.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when sheet size exceeds the limits")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when any sheet is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// data represented as an object with sheets: Sheet1 and Sheet2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetData "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Sheet2'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(9, 3, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// method with optional config parameter useColumnIndex")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetData"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("useColumnIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheets")])]),t._v(" "),s("td",[t._v("Sheets")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("object with sheets definition")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("configInput")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("{}")]),t._v(" "),s("td",[t._v("engine configuration")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("namedExpressions")])]),t._v(" "),s("td",[t._v("SerializedNamedExpression[]")]),t._v(" "),s("td",[t._v("[]")]),t._v(" "),s("td",[t._v("starting named expressions")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html"}},[t._v("HyperFormula")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"instance"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#instance"}},[t._v("#")]),t._v(" Instance")]),t._v(" "),s("h3",{attrs:{id:"destroy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" destroy")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("destroy")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4402",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4402"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Destroys instance of HyperFormula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// destroys the instance")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("destroy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getconfig"}},[t._v("#")]),t._v(" getConfig")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getConfig")]),t._v("(): "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1019",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1019"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns current configuration of the engine instance.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all config metadata including default and those which were added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfConfig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getConfig")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"rebuildandrecalculate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rebuildandrecalculate"}},[t._v("#")]),t._v(" rebuildAndRecalculate")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("rebuildAndRecalculate")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1033",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1033"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Rebuilds the HyperFormula instance preserving the current sheets data.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rebuildAndRecalculate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"updateconfig"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("updateConfig")]),t._v("("),s("code",[t._v("newParams")]),t._v(": Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›): "),s("em",[t._v("void")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L998",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:998"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Updates the config with given new metadata. It is an expensive operation, as it might trigger rebuilding the engine and recalculation of all formulas.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when some parameters of config are of wrong type (e.g., currencySymbol)")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ConfigValueEmpty]] when some parameters of config are of invalid value (e.g., currencySymbol)")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a config param, for example maxColumns,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you can check the configuration with getConfig method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfig")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxColumns")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("newParams")])]),t._v(" "),s("td",[t._v("Partial‹"),s("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1),t._v(" "),s("td",[t._v("configuration options to be updated or added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"sheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheets"}},[t._v("#")]),t._v(" Sheets")]),t._v(" "),s("h3",{attrs:{id:"addsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addsheet"}},[t._v("#")]),t._v(" addSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addSheet")]),t._v("("),s("code",[t._v("sheetName?")]),t._v(": undefined | string): "),s("em",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2571",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2571"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a new sheet to the HyperFormula instance. Returns given or autogenerated name of a new sheet.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetadded"}},[t._v("sheetAdded")]),t._v(" after the sheet was added")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetNameAlreadyTakenError]] when sheet with a given name already exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'MySheet3'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nameProvided "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return autogenerated 'Sheet4'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// because no name was provided and 3 other ones already exist")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" generatedName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName?")])]),t._v(" "),s("td",[t._v("undefined | string")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"clearsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearsheet"}},[t._v("#")]),t._v(" clearSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2718",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2718"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the sheet content. Double-checks if the sheet exists.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"countsheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#countsheets"}},[t._v("#")]),t._v(" countSheets")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("countSheets")]),t._v("(): "),s("em",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3360",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3360"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the number of existing sheets.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return the number of sheets which is '1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetsCount "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("countSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("number")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"doessheetexist"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doessheetexist"}},[t._v("#")]),t._v(" doesSheetExist")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesSheetExist")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3083",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3083"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" whether sheet with a given name exists. The method accepts sheet name to be checked.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since 'MySheet1' exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetExist "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesSheetExist")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("name of the sheet, case-insensitive.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsdimensions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsdimensions"}},[t._v("#")]),t._v(" getAllSheetsDimensions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsDimensions")]),t._v("(): "),s("em",[t._v("Record‹string, SheetDimensions›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L882",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:882"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a map containing dimensions of all sheets for the engine instance represented as a key-value pairs where keys are sheet IDs and dimensions are returned as numbers, width and height respectively.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return the dimensions of all sheets:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// { Sheet1: { width: 3, height: 1 }, Sheet2: { width: 1, height: 2 } }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsDimensions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsDimensions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, SheetDimensions›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsformulas"}},[t._v("#")]),t._v(" getAllSheetsFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsFormulas")]),t._v("(): "),s("em",[t._v("Record‹string, (string | undefined)[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L951",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:951"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns formulas of all sheets in a form of an object which property keys are strings and values are 2D arrays of strings or possibly "),s("code",[t._v("undefined")]),t._v(" when the call does not contain a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return only formulas: { Sheet1: [ [ undefined, undefined, '=A1+10' ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, (string | undefined)[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsserialized"}},[t._v("#")]),t._v(" getAllSheetsSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsSerialized")]),t._v("(): "),s("em",[t._v("Record‹string, RawCellContent[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L972",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:972"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns formulas or values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[RawCellContent]].")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets serialized content: { Sheet1: [ [ 1, 2, '=A1+10' ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsSerialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, RawCellContent[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallsheetsvalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallsheetsvalues"}},[t._v("#")]),t._v(" getAllSheetsValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllSheetsValues")]),t._v("(): "),s("em",[t._v("Record‹string, CellValue[][]›")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L932",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:932"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns values of all sheets in a form of an object which property keys are strings and values are 2D arrays of [[CellValue]].")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets values: { Sheet1: [ [ 1, 11, 3 ] ] }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allSheetsValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("Record‹string, CellValue[][]›")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetdimensions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetdimensions"}},[t._v("#")]),t._v(" getSheetDimensions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetDimensions")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("SheetDimensions")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L907",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:907"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns dimensions of a specified sheet.\nThe sheet dimensions is represented with numbers: width and height.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet2!$A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return provided sheet's dimensions: { width: 3, height: 1 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetDimensions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetDimensions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SheetDimensions")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetformulas"}},[t._v("#")]),t._v(" getSheetFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetFormulas")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L819",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:819"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array with normalized formula strings from [[Sheet]] or "),s("code",[t._v("undefined")]),t._v(" for a cells that have no value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all formulas of a sheet:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=SUM(1, 2, 3)', '=A1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=TEXT(A2, \"0.0%\")', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [undefined, '=SUM(A1:C1)', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ];")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetid"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetid"}},[t._v("#")]),t._v(" getSheetId")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetId")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("number | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3058",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3058"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a unique sheet ID assigned to the sheet with a given name or "),s("code",[t._v("undefined")]),t._v(" if the sheet does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return '0' because 'MySheet1' is of ID '0'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetID "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("name of the sheet, for which we want to retrieve ID, case-insensitive.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("number | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetname"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetname"}},[t._v("#")]),t._v(" getSheetName")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetName")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3012",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3012"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a unique sheet name assigned to the sheet of a given ID or "),s("code",[t._v("undefined")]),t._v(" if the there is no sheet with a given ID.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'MySheet2' as this sheet is the second one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of the sheet, for which we want to retrieve name")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetnames"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetnames"}},[t._v("#")]),t._v(" getSheetNames")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetNames")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3034",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3034"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("List all sheet names.\nReturns an array of sheet names as strings.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all sheets names: ['MySheet1', 'MySheet2']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetserialized"}},[t._v("#")]),t._v(" getSheetSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetSerialized")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L852",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:852"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array of arrays of [[RawCellContent]] with serialized content of cells from [[Sheet]], either a cell formula or an explicit value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['0', '=SUM(1, 2, 3)', '=A1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['1', '=TEXT(A2, \"0.0%\")', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['2', '=SUM(A1:C1)', '=C1'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ];")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" serializedContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getsheetvalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getsheetvalues"}},[t._v("#")]),t._v(" getSheetValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getSheetValues")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L786",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:786"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns an array of arrays of [[CellValue]] with values of all cells from [[Sheet]].\nApplies rounding and post-processing.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=TEXT(A2, \"0.0%\")'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=C1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all values of a sheet: [[0, 6, 0], [1, '1.0%', 0], [2, 6, 0]]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID number")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddsheet"}},[t._v("#")]),t._v(" isItPossibleToAddSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddSheet")]),t._v("("),s("code",[t._v("sheetName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2534",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2534"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add a sheet to the engine.\nChecks against particular rules to ascertain that addSheet can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addsheet"}},[t._v("addSheet")]),t._v(" operation won't throw any errors, and it is possible to add sheet with provided name.\nReturns "),s("code",[t._v("false")]),t._v(" if the chosen name is already used.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' because 'MySheet2' already exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("sheet name, case-insensitive")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoclearsheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoclearsheet"}},[t._v("#")]),t._v(" isItPossibleToClearSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToClearSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2676",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2676"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to clear a specified sheet.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#clearsheet"}},[t._v("clearSheet")]),t._v(" operation won't throw any errors, provided sheet exists and its content can be cleared.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because 'MySheet2' exists and can be cleared")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isClearable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToClearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovesheet"}},[t._v("#")]),t._v(" isItPossibleToRemoveSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2602",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2602"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove sheet for the engine.\nReturns "),s("code",[t._v("true")]),t._v(" if the provided sheet exists, and therefore it can be removed, doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removesheet"}},[t._v("removeSheet")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because sheet with ID 1 exists and is removable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletorenamesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletorenamesheet"}},[t._v("#")]),t._v(" isItPossibleToRenameSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRenameSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newName")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3387"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to rename sheet.\nReturns "),s("code",[t._v("true")]),t._v(" if the sheet with provided id exists and new name is available\nReturns "),s("code",[t._v("false")]),t._v(" if sheet cannot be renamed")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRenameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the sheet to be given")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoreplacesheetcontent"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoreplacesheetcontent"}},[t._v("#")]),t._v(" isItPossibleToReplaceSheetContent")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToReplaceSheetContent")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("values")]),t._v(": RawCellContent[][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2748",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2748"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to replace the sheet content.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#setsheetcontent"}},[t._v("setSheetContent")]),t._v(" operation won't throw any errors, the provided sheet exists and then its content can be replaced.\nReturns "),s("code",[t._v("false")]),t._v(" otherwise")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' because sheet of ID 0 exists")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// and the provided content can be placed in this sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isReplaceable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToReplaceSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("values")])]),t._v(" "),s("td",[t._v("RawCellContent[][]")]),t._v(" "),s("td",[t._v("array of new values")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removesheet"}},[t._v("#")]),t._v(" removeSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2645",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2645"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a sheet")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetremoved"}},[t._v("sheetRemoved")]),t._v(" after the sheet was removed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: { error: [CellError], value: '#REF!' },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"renamesheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#renamesheet"}},[t._v("#")]),t._v(" renameSheet")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("renameSheet")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newName")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3423",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3423"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Renames a specified sheet.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#sheetrenamed"}},[t._v("sheetRenamed")]),t._v(" after the sheet was renamed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetNameAlreadyTakenError]] when the provided sheet name already exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// renames the sheet 'MySheet1'")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet ID")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the sheet to be given, if is the same as the old one the method does nothing")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setsheetcontent"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setsheetcontent"}},[t._v("#")]),t._v(" setSheetContent")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setSheetContent")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("values")]),t._v(": RawCellContent[][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2785",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2785"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Replaces the sheet content with new values.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when values argument is not an array of arrays")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("values")])]),t._v(" "),s("td",[t._v("RawCellContent[][]")]),t._v(" "),s("td",[t._v("array of new values")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"ranges"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#ranges"}},[t._v("#")]),t._v(" Ranges")]),t._v(" "),s("h3",{attrs:{id:"getfillrangedata"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfillrangedata"}},[t._v("#")]),t._v(" getFillRangeData")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFillRangeData")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("target")]),t._v(": SimpleCellRange, "),s("code",[t._v("offsetsFromTarget")]),t._v(": boolean): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2490",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2490"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns values to fill target range using source range, with properly extending the range using wrap-around heuristic.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source or target are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=$A$1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return [['2', '=$A$1', '2'], ['=A3', 1, '=C3'], ['2', '=$A$1', '2']]")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFillRangeData")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("of data")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("target")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("-")]),t._v(" "),s("td",[t._v("range where data is intended to be put")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("offsetsFromTarget")])]),t._v(" "),s("td",[t._v("boolean")]),t._v(" "),s("td",[t._v("false")]),t._v(" "),s("td",[t._v("if true, offsets are computed from target corner, otherwise from source corner")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangeformulas"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangeformulas"}},[t._v("#")]),t._v(" getRangeFormulas")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeFormulas")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2420",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2420"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns cell formulas in given range.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns cell formulas of a given range only:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ '=SUM(1, 2)', undefined ], [ undefined, undefined ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeFormulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeFormulas")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(string | undefined)[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangeserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangeserialized"}},[t._v("#")]),t._v(" getRangeSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeSerialized")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2456",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2456"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns serialized cells in given range.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized cell content for the given range:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ '=SUM(1, 2)', 2 ], [ 5, 6 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeSerialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getrangevalues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getrangevalues"}},[t._v("#")]),t._v(" getRangeValues")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRangeValues")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2384",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2384"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the cell content of a given range in a [[CellValue]][][] format.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'40'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'30'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'20'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns calculated cells content: [ [ 3, 2 ], [ 5, 6 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rangeValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRangeValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangular range")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rows"}},[t._v("#")]),t._v(" Rows")]),t._v(" "),s("h3",{attrs:{id:"addrows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addrows"}},[t._v("#")]),t._v(" addRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1641",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1641"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds multiple rows into a specified position in a given sheet.\nDoes nothing if rows are outside effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which rows will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddrows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddrows"}},[t._v("#")]),t._v(" isItPossibleToAddRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1599",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1599"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add rows into a specified position in a given sheet.\nChecks against particular rules to ascertain that addRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addrows"}},[t._v("addRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if adding rows would exceed the sheet size limit or given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add one row in the second row of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which rows will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [row, amount], where row is a row number above which the rows will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomoverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomoverows"}},[t._v("#")]),t._v(" isItPossibleToMoveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startRow")]),t._v(": number, "),s("code",[t._v("numberOfRows")]),t._v(": number, "),s("code",[t._v("targetRow")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1996",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1996"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move a particular number of rows to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#moverows"}},[t._v("moveRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected rows, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move one row from row 0 into row 2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first row to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfRows")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of rows to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("row number before which rows will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremoverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremoverows"}},[t._v("#")]),t._v(" isItPossibleToRemoveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1672",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1672"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove rows from a specified position in a given sheet.\nChecks against particular rules to ascertain that removeRows can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removerows"}},[t._v("removeRows")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to remove one row from row 1 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which rows will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [row, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetroworder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetroworder"}},[t._v("#")]),t._v(" isItPossibleToSetRowOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetRowOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newRowOrder")]),t._v(": number[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1402",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1402"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder rows of a sheet according to a permutation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newRowOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoswaprowindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoswaprowindexes"}},[t._v("#")]),t._v(" isItPossibleToSwapRowIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSwapRowIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("rowMapping")]),t._v(": [number, number][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1323",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1323"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder rows of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSwappable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSwappable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rowMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"moverows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moverows"}},[t._v("#")]),t._v(" moveRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startRow")]),t._v(": number, "),s("code",[t._v("numberOfRows")]),t._v(": number, "),s("code",[t._v("targetRow")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2043"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves a particular number of rows to a specified position in a given sheet.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first row to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfRows")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of rows to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetRow")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("row number before which rows will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removerows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removerows"}},[t._v("#")]),t._v(" removeRows")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeRows")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1713",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1713"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes multiple rows from a specified position in a given sheet.\nDoes nothing if rows are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return: [{ sheet: 0, col: 1, row: 2, value: null }] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which rows will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [row, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setroworder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setroworder"}},[t._v("#")]),t._v(" setRowOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setRowOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newRowOrder")]),t._v(": number[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1371",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1371"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders rows of a sheet according to a permutation of 0-based indexes.\nParameter "),s("code",[t._v("newRowOrder")]),t._v(" should have a form "),s("code",[t._v("[ newPositionForRow0, newPositionForRow1, newPositionForRow2, ... ]")]),t._v(".\nThis method might be used to "),s("RouterLink",{attrs:{to:"/guide/sorting-data.html"}},[t._v("sort the rows of a sheet")]),t._v(".")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note: This method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'C'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'D'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" newRowOrder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ newPosForA, newPosForB, newPosForC, newPosForD ]")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newRowOrder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sheet after this operation: [['A'], ['D'], ['C'], ['B']]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newRowOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"swaprowindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#swaprowindexes"}},[t._v("#")]),t._v(" swapRowIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("swapRowIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("rowMapping")]),t._v(": [number, number][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1292",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1292"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders rows of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when rowMapping does not define correct row permutation for some subset of rows of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set swap rows 0 and 2 in place, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 2 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 2 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: null,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 4,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 5,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapRowIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rowMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of rows")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#columns"}},[t._v("#")]),t._v(" Columns")]),t._v(" "),s("h3",{attrs:{id:"addcolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addcolumns"}},[t._v("#")]),t._v(" addColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1789",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1789"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds multiple columns into a specified position in a given sheet.\nDoes nothing if the columns are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.92754862796338,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which columns will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddcolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddcolumns"}},[t._v("#")]),t._v(" isItPossibleToAddColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1743",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1743"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add columns into a specified position in a given sheet.\nChecks against particular rules to ascertain that addColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addcolumns"}},[t._v("addColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if adding columns would exceed the sheet size limit or given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add 1 column in sheet 0, at column 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID in which columns will be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount], where column is a column number from which new columns will be added")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomovecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomovecolumns"}},[t._v("#")]),t._v(" isItPossibleToMoveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startColumn")]),t._v(": number, "),s("code",[t._v("numberOfColumns")]),t._v(": number, "),s("code",[t._v("targetColumn")]),t._v(": number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2078",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2078"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move a particular number of columns to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecolumns"}},[t._v("moveColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move one column from column 1 into column 2 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first column to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfColumns")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of columns to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("column number before which columns will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovecolumns"}},[t._v("#")]),t._v(" isItPossibleToRemoveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1819",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1819"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove columns from a specified position in a given sheet.\nChecks against particular rules to ascertain that removeColumns can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removecolumns"}},[t._v("removeColumns")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if given arguments are invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to remove one column, in place of the second column of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which columns will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format [column, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetcolumnorder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetcolumnorder"}},[t._v("#")]),t._v(" isItPossibleToSetColumnOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetColumnOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newColumnOrder")]),t._v(": number[]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1563",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1563"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder columns of a sheet according to a permutation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newColumnOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoswapcolumnindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoswapcolumnindexes"}},[t._v("#")]),t._v(" isItPossibleToSwapColumnIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSwapColumnIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("columnMapping")]),t._v(": [number, number][]): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1488",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1488"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if it is possible to reorder columns of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns true")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns false")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSwapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("columnMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"movecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#movecolumns"}},[t._v("#")]),t._v(" moveColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("startColumn")]),t._v(": number, "),s("code",[t._v("numberOfColumns")]),t._v(": number, "),s("code",[t._v("targetColumn")]),t._v(": number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2131",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2131"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves a particular number of columns to a specified position in a given sheet.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:C1)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.16210054671639,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }, {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 4, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 6.16210054671639,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("a sheet number in which the operation will be performed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("startColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of the first column to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("numberOfColumns")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of columns to move")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("targetColumn")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("column number before which columns will be moved")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removecolumns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removecolumns"}},[t._v("#")]),t._v(" removeColumns")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeColumns")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, ..."),s("code",[t._v("indexes")]),t._v(": ColumnRowIndex[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1864"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes multiple columns from a specified position in a given sheet.\nDoes nothing if columns are outside the effective sheet size.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, in this example it will return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 1, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: { error: [CellError], value: '#REF!' },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("sheet ID from which columns will be removed")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("...indexes")])]),t._v(" "),s("td",[t._v("ColumnRowIndex[]")]),t._v(" "),s("td",[t._v("non-contiguous indexes with format: [column, amount]")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setcolumnorder"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setcolumnorder"}},[t._v("#")]),t._v(" setColumnOrder")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setColumnOrder")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("newColumnOrder")]),t._v(": number[]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1533",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1533"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders columns of a sheet according to a permutation of 0-based indexes.\nParameter "),s("code",[t._v("newColumnOrder")]),t._v(" should have a form "),s("code",[t._v("[ newPositionForColumn0, newPositionForColumn1, newPositionForColumn2, ... ]")]),t._v(".\nThis method might be used to "),s("RouterLink",{attrs:{to:"/guide/sorting-data.html"}},[t._v("sort the columns of a sheet")]),t._v(".")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note: This method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'C'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'D'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" newColumnOrder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ newPosForA, newPosForB, newPosForC, newPosForD ]")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newColumnOrder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sheet after this operation: [['A', 'D', 'C', 'B']]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newColumnOrder")])]),t._v(" "),s("td",[t._v("number[]")]),t._v(" "),s("td",[t._v("permutation of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"swapcolumnindexes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#swapcolumnindexes"}},[t._v("#")]),t._v(" swapColumnIndexes")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("swapColumnIndexes")]),t._v("("),s("code",[t._v("sheetId")]),t._v(": number, "),s("code",[t._v("columnMapping")]),t._v(": [number, number][]): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1460",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1460"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Reorders columns of a sheet according to a source-target mapping.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when columnMapping does not define correct column permutation for some subset of columns of the given sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the selected position has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set swap columns 0 and 2 in place, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 2, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 2, row: 1 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 5,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 4,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 1 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: null,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapColumnIndexes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("ID of a sheet to operate on")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("columnMapping")])]),t._v(" "),s("td",[t._v("[number, number][]")]),t._v(" "),s("td",[t._v("array mapping original positions to final positions of columns")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cells"}},[t._v("#")]),t._v(" Cells")]),t._v(" "),s("h3",{attrs:{id:"doescellhaveformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doescellhaveformula"}},[t._v("#")]),t._v(" doesCellHaveFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesCellHaveFormula")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3175",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3175"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if the specified cell contains a formula.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since the A1 cell contains a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' since the B1 cell does not contain a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1NoFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"doescellhavesimplevalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#doescellhavesimplevalue"}},[t._v("#")]),t._v(" doesCellHaveSimpleValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("doesCellHaveSimpleValue")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3144",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3144"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if the specified cell contains a simple value.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' since the selected cell contains a simple value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isA1Simple "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveSimpleValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false' since the selected cell does not contain a simple value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isB1Simple "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("doesCellHaveSimpleValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellformula"}},[t._v("#")]),t._v(" getCellFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellFormula")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L692",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:692"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a normalized formula string from the cell of a given address or "),s("code",[t._v("undefined")]),t._v(" for an address that does not exist and empty values.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a normalized A1 cell formula: '=SUM(1, 2, 3)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a normalized B1 cell formula: 'undefined'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellhyperlink"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellhyperlink"}},[t._v("#")]),t._v(" getCellHyperlink")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellHyperlink")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:722"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the "),s("code",[t._v("HYPERLINK")]),t._v(" url for a cell of a given address or "),s("code",[t._v("undefined")]),t._v(" for an address that does not exist or a cell that is not "),s("code",[t._v("HYPERLINK")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('\'=HYPERLINK("https://hyperformula.handsontable.com/", "HyperFormula")\'')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return url of 'HYPERLINK': https://hyperformula.handsontable.com/")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Hyperlink "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellHyperlink")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'undefined' for a cell that is not 'HYPERLINK'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Hyperlink "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellHyperlink")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellserialized"}},[t._v("#")]),t._v(" getCellSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellSerialized")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("RawCellContent")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L754",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:754"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns [[RawCellContent]] with a serialized content of the cell of a given address: either a cell formula, an explicit value, or an error.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized content of A1 cell: '=SUM(1, 2, 3)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellA1Serialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return serialized content of B1 cell: '0'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellB1Serialized "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("RawCellContent")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcelltype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcelltype"}},[t._v("#")]),t._v(" getCellType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3112",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3112"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the type of a cell at a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A2:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'FORMULA', the cell of given coordinates is of this type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellA1Type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'VALUE', the cell of given coordinates is of this type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellB1Type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvalue"}},[t._v("#")]),t._v(" getCellValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValue")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValue")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L661",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:661"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns the cell value of a given address.\nApplies rounding and post-processing.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] when cellAddress is of incorrect type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get value of A1 cell, should be '6'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get value of B1 cell, should be '2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvaluedetailedtype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvaluedetailedtype"}},[t._v("#")]),t._v(" getCellValueDetailedType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueDetailedType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValueDetailedType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3302",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3302"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns detailed type of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1%'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1$'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER_PERCENT', cell value type of provided coordinates is a number with a format inference percent.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellType "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueDetailedType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER_CURRENCY', cell value type of provided coordinates is a number with a format inference currency.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellType "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueDetailedType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValueDetailedType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvalueformat"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvalueformat"}},[t._v("#")]),t._v(" getCellValueFormat")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueFormat")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("FormatInfo")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3336",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3336"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns auxiliary format information of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1$'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return '$', cell value type of provided coordinates is a number with a format inference currency, parsed as using '$' as currency.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellFormat "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return undefined, cell value type of provided coordinates is a number with no format information.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellFormat "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FormatInfo")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellvaluetype"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellvaluetype"}},[t._v("#")]),t._v(" getCellValueType")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellValueType")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("CellValueType")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3268",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3268"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns type of the cell value of a given address.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2, 3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER', cell value type of provided coordinates is a number")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'NUMBER', cell value type of provided coordinates is a number")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cellValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValueType")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValueType")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"iscellempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#iscellempty"}},[t._v("#")]),t._v(" isCellEmpty")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isCellEmpty")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3207",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3207"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns"),s("code",[t._v("true")]),t._v(" if the specified cell is empty.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', cell of provided coordinates is empty")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'false', cell of provided coordinates is not empty")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isNotEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"iscellpartofarray"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#iscellpartofarray"}},[t._v("#")]),t._v(" isCellPartOfArray")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isCellPartOfArray")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3235",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3235"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns "),s("code",[t._v("true")]),t._v(" if a given cell is a part of an array.\nThe method accepts cell coordinates as object with column, row and sheet numbers.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if cellAddress is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'{=TRANSPOSE(B1:B1)}'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', cell of provided coordinates is a part of an array")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isPartOfArray "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isCellPartOfArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("cell coordinates")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletomovecells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletomovecells"}},[t._v("#")]),t._v(" isItPossibleToMoveCells")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToMoveCells")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("destinationLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1900",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1900"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to move cells to a specified position in a given sheet.\nChecks against particular rules to ascertain that moveCells can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted and causes side effects by the fact that there is an array inside the selected columns, the target location includes an array or the provided address is invalid.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if destinationLeftCorner, source, or any of basic type arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the coordinates and assign them to variables")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to move a block of width 1 and height 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// from the corner: column 1 and row 0 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// into destination corner: column 3, row 0 of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isMovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToMoveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("range for a moved block")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("destinationLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletosetcellcontents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletosetcellcontents"}},[t._v("#")]),t._v(" isItPossibleToSetCellContents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToSetCellContents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1187",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1187"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to change the content in a rectangular area bounded by the box.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#setcellcontents"}},[t._v("setCellContents")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the address is invalid or the sheet does not exist.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// top left corner")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address1 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// bottom right corner")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address2 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example, it is possible to set content of")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// width 2, height 1 in the first row and column of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSettable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToSetCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address1"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" address2 "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("single cell or block of cells to check")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"movecells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#movecells"}},[t._v("#")]),t._v(" moveCells")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("moveCells")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange, "),s("code",[t._v("destinationLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1957",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1957"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Moves the content of a cell block from source to the target location.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if destinationLeftCorner or source are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the given arguments are invalid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SourceLocationHasArrayError]] when the source location has array inside - array cannot be moved")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the target location has array inside - cells cannot be replaced by the array")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=RAND()'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the coordinates and assign them to variables")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return a list of cells which values changed after the operation,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// their absolute addresses and new values, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 0, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 0.93524248002062,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("range for a moved block")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("destinationLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"setcellcontents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setcellcontents"}},[t._v("#")]),t._v(" setCellContents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("setCellContents")]),t._v("("),s("code",[t._v("topLeftCornerAddress")]),t._v(": SimpleCellAddress, "),s("code",[t._v("cellContents")]),t._v(": RawCellContent[][] | RawCellContent): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1240",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1240"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Sets the content for a block of cells of a given coordinates.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[InvalidArgumentsError]] when the value is not an array of arrays or a raw cell value")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if topLeftCornerAddress argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should set the content, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, col: 3, row: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 2,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("topLeftCornerAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("top left corner of block of cells")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("cellContents")])]),t._v(" "),s("td",[t._v("RawCellContent[][] | RawCellContent")]),t._v(" "),s("td",[t._v("array with content")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"named-expressions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#named-expressions"}},[t._v("#")]),t._v(" Named Expressions")]),t._v(" "),s("h3",{attrs:{id:"addnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#addnamedexpression"}},[t._v("#")]),t._v(" addNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("addNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("expression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number, "),s("code",[t._v("options?")]),t._v(": NamedExpressionOptions): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3653",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3653"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a specified named expression.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#namedexpressionadded"}},[t._v("namedExpressionAdded")]),t._v(" always, unless "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#batch"}},[t._v("batch")]),t._v(" mode is used")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionNameIsAlreadyTakenError]] when the named-expression name is not available.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionNameIsInvalidError]] when the named-expression name is not valid")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoRelativeAddressesAllowedError]] when the named-expression formula contains relative references")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add own expression, scope limited to 'Sheet1' (sheetId=0), the method should return a list of cells which values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// changed after the operation, their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// name: 'prettyName',")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 142,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the expression to be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("expression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("the expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("options?")])]),t._v(" "),s("td",[t._v("NamedExpressionOptions")]),t._v(" "),s("td",[t._v("additional metadata related to named expression")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"changenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#changenamedexpression"}},[t._v("#")]),t._v(" changeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("changeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("newExpression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number, "),s("code",[t._v("options?")]),t._v(": NamedExpressionOptions): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3869",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3869"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Changes a given named expression to a specified formula.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionDoesNotExistError]] when the given expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ArrayFormulasNotSupportedError]] when the named expression formula is an array formula")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoRelativeAddressesAllowedError]] when the named expression formula contains relative references")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression, scope limited to 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// change the named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("changeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+200'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newExpression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("a new expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("options?")])]),t._v(" "),s("td",[t._v("NamedExpressionOptions")]),t._v(" "),s("td",[t._v("additional metadata related to named expression")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getallnamedexpressionsserialized"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallnamedexpressionsserialized"}},[t._v("#")]),t._v(" getAllNamedExpressionsSerialized")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllNamedExpressionsSerialized")]),t._v("(): "),s("em",[t._v("SerializedNamedExpression[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4033",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4033"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all named expressions serialized.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add two named expressions and one scoped")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'anotherPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$2+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$3+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get all expressions serialized")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'prettyName', expression: '=Sheet1!$A$1+100', options: undefined, scope: undefined},")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'anotherPrettyName', expression: '=Sheet1!$A$2+100', options: undefined, scope: undefined},")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'alsoPrettyName', expression: '=Sheet1!$A$3+100', options: undefined, scope: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllNamedExpressionsSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SerializedNamedExpression[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpression"}},[t._v("#")]),t._v(" getNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("NamedExpression | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3772",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3772"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a named expression, or "),s("code",[t._v("undefined")]),t._v(" for a named expression that does not exist or does not hold a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression in 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a named expression that corresponds to the passed name from 'Sheet1' (sheetId=0)")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {name: 'prettyName', expression: '=Sheet1!$A$1+100', options: undefined, scope: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for a named expression that doesn't exist, returns 'undefined':")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormulaTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("NamedExpression | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionformula"}},[t._v("#")]),t._v(" getNamedExpressionFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionFormula")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3729",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3729"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns a normalized formula string for given named expression, or "),s("code",[t._v("undefined")]),t._v(" for a named expression that does not exist or does not hold a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression in 'Sheet1' (sheetId=0)")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a normalized formula string corresponding to the passed name from 'Sheet1' (sheetId=0),")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// '=Sheet1!A1+100' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionvalue"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionvalue"}},[t._v("#")]),t._v(" getNamedExpressionValue")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionValue")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("CellValue | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3689",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3689"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Gets specified named expression value.\nReturns a [[CellValue]] or undefined if the given named expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression, only 'Sheet1' (sheetId=0) considered as it is the scope")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the calculated value of a passed named expression, '142' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoaddnamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoaddnamedexpression"}},[t._v("#")]),t._v(" isItPossibleToAddNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToAddNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("expression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3601",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3601"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to add named expression into a specific scope.\nChecks against particular rules to ascertain that addNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#addnamedexpression"}},[t._v("addNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to add named expression to global scope")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToAddNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("a name of the expression to be added")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("expression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("the expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletochangenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletochangenamedexpression"}},[t._v("#")]),t._v(" isItPossibleToChangeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToChangeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("newExpression")]),t._v(": RawCellContent, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3821",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3821"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to change named expression in a specific scope.\nChecks against particular rules to ascertain that changeNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#changenamedexpression"}},[t._v("changeNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to change named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToChangeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newExpression")])]),t._v(" "),s("td",[t._v("RawCellContent")]),t._v(" "),s("td",[t._v("a new expression")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isitpossibletoremovenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibletoremovenamedexpression"}},[t._v("#")]),t._v(" isItPossibleToRemoveNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isItPossibleToRemoveNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3905",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3905"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether it is possible to remove named expression from a specific scope.\nChecks against particular rules to ascertain that removeNamedExpression can be called.\nIf returns "),s("code",[t._v("true")]),t._v(", doing "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#removenamedexpression"}},[t._v("removeNamedExpression")]),t._v(" operation won't throw any errors.\nReturns "),s("code",[t._v("false")]),t._v(" if the operation might be disrupted.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true' for this example,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it is possible to change named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isAddable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("an expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"listnamedexpressions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listnamedexpressions"}},[t._v("#")]),t._v(" listNamedExpressions")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("listNamedExpressions")]),t._v("("),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3997",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3997"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Lists named expressions.")]),t._v(" "),s("ul",[s("li",[t._v("If scope parameter is provided, returns an array of expression names defined for this scope.")]),t._v(" "),s("li",[t._v("If scope parameter is undefined, returns an array of global expression names.")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add two named expressions and one scoped")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'anotherPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$2+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'alsoPrettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$3+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// list the expressions, should return: ['prettyName', 'anotherPrettyName'] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" listOfExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listNamedExpressions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// list the expressions, should return: ['alsoPrettyName'] for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" listOfExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listNamedExpressions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope of the named expressions, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"removenamedexpression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removenamedexpression"}},[t._v("#")]),t._v(" removeNamedExpression")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("removeNamedExpression")]),t._v("("),s("code",[t._v("expressionName")]),t._v(": string, "),s("code",[t._v("scope?")]),t._v(": undefined | number): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3950",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3950"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a named expression.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#namedexpressionremoved"}},[t._v("namedExpressionRemoved")]),t._v(" after the expression was removed")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NamedExpressionDoesNotExistError]] when the given expression does not exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] if no sheet with given sheetId exists")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove the named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("expressionName")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("expression name, case-insensitive.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("scope?")])]),t._v(" "),s("td",[t._v("undefined | number")]),t._v(" "),s("td",[t._v("scope definition, "),s("code",[t._v("sheetId")]),t._v(" for local scope or "),s("code",[t._v("undefined")]),t._v(" for global scope")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"helpers"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#helpers"}},[t._v("#")]),t._v(" Helpers")]),t._v(" "),s("h3",{attrs:{id:"calculateformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#calculateformula"}},[t._v("#")]),t._v(" calculateFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("calculateFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("CellValue | CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4098",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4098"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Calculates fire-and-forget formula, returns the calculated value.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with "),s("code",[t._v("=")]),t._v(").")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the provided "),s("code",[t._v("sheetID")]),t._v(" doesn't exist.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'58'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Sheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the calculated formula's value")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns `68`")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" calculatedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("calculateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns [['11', '12', '13'], ['14', '15', '16']]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" calculatedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("calculateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1:B3+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("A formula in a proper format, starting with "),s("code",[t._v("=")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("The ID of a sheet in context of which the formula gets evaluated.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue | CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcelldependents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcelldependents"}},[t._v("#")]),t._v(" getCellDependents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellDependents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2939",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2939"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all the out-neighbors in the "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html"}},[t._v("dependency graph")]),t._v(" for a given cell address or range. Including:")],1),t._v(" "),s("ul",[s("li",[t._v("All cells with formulas that contain the given cell address or range")]),t._v(" "),s("li",[t._v("Some of the ranges that contain the given cell address or range")])]),t._v(" "),s("p",[t._v("The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html#optimizations-for-large-ranges"}},[t._v('"Optimizations for large ranges"')]),t._v(".")],1),t._v(" "),s("p",[t._v("The returned array includes also named expression dependents. They are represented as cell references with sheet ID "),s("code",[t._v("-1")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellDependents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns [{ sheet: 0, col: 1, row: 0}, { sheet: 0, col: 2, row: 0}]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute address or range of addresses")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getcellprecedents"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getcellprecedents"}},[t._v("#")]),t._v(" getCellPrecedents")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getCellPrecedents")]),t._v("("),s("code",[t._v("address")]),t._v(": SimpleCellAddress | SimpleCellRange): "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2977",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2977"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all the in-neighbors in the "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html"}},[t._v("dependency graph")]),t._v(" for a given cell address or range. In particular:")],1),t._v(" "),s("ul",[s("li",[t._v("If the argument is a single cell, "),s("code",[t._v("getCellPrecedents()")]),t._v(" returns all cells and ranges contained in that cell's formula.")]),t._v(" "),s("li",[t._v("If the argument is a range of cells, "),s("code",[t._v("getCellPrecedents()")]),t._v(" returns some of the cell addresses and smaller ranges contained in that range (but not all of them). The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "),s("RouterLink",{attrs:{to:"/guide/dependency-graph.html#optimizations-for-large-ranges"}},[t._v('"Optimizations for large ranges"')]),t._v(".")],1)]),t._v(" "),s("p",[t._v("The returned array includes also named expression precedents. They are represented as cell references with sheet ID "),s("code",[t._v("-1")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if address is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1+B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellPrecedents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns [{ sheet: 0, col: 0, row: 0}, { sheet: 0, col: 1, row: 0}]")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("address")])]),t._v(" "),s("td",[t._v("SimpleCellAddress | SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute address or range of addresses")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("(SimpleCellRange | SimpleCellAddress)[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getnamedexpressionsfromformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getnamedexpressionsfromformula"}},[t._v("#")]),t._v(" getNamedExpressionsFromFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getNamedExpressionsFromFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4129",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4129"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Return a list of named expressions used by a formula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NotAFormulaError]] when the provided string is not a valid formula (i.e., doesn't start with "),s("code",[t._v("=")]),t._v(").")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a list of named expressions used by a formula")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// for this example, returns ['foo', 'bar']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" namedExpressions "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getNamedExpressionsFromFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=foo+bar*2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("A formula in a proper format, starting with "),s("code",[t._v("=")]),t._v(".")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"normalizeformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#normalizeformula"}},[t._v("#")]),t._v(" normalizeFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("normalizeFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4062",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4062"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Parses and then unparses a formula.\nReturns a normalized formula (e.g., restores the original capitalization of sheet names, function names, cell addresses, and named expressions).")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(' [[NotAFormulaError]] when the provided string is not a valid formula, i.e., does not start with "="')]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns '=Sheet1!$A$1+10'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" normalizedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("normalizeFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SHEET1!$A$1+10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns '=3*$A$1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" normalizedFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("normalizeFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=3*$a$1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v('a formula in a proper format - it must start with "="')])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertodate"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertodate"}},[t._v("#")]),t._v(" numberToDate")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToDate")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4278",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4278"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a date.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass the number of days since nullDate")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the method should return formatted date, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {year: 2020, month: 1, day: 15}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dateFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("43845")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of days since nullDate, should be non-negative, fractions are ignored.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertodatetime"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertodatetime"}},[t._v("#")]),t._v(" numberToDateTime")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToDateTime")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4254",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4254"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a date + time.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass the number of days since nullDate")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the method should return formatted date and time, for this example:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// {year: 2020, month: 1, day: 15, hours: 2, minutes: 24, seconds: 0}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dateTimeFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToDateTime")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("43845.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"numbertotime"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#numbertotime"}},[t._v("#")]),t._v(" numberToTime")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("numberToTime")]),t._v("("),s("code",[t._v("inputNumber")]),t._v(": number): "),s("em",[t._v("DateTime")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4301",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4301"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Interprets number as a time (hours/minutes/seconds).")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pass a number to be interpreted as a time")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return {hours: 26, minutes: 24} for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" timeFromNumber "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numberToTime")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("inputNumber")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("time in 24h units.")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("DateTime")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecelladdressfromstring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecelladdressfromstring"}},[t._v("#")]),t._v(" simpleCellAddressFromString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellAddressFromString")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": string, "),s("code",[t._v("contextSheetId")]),t._v(": number): "),s("em",[t._v("SimpleCellAddress | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2821",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2821"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes the simple (absolute) address of a cell address, based on its string representation.")]),t._v(" "),s("ul",[s("li",[t._v("If a sheet name is present in the string representation but is not present in the engine, returns "),s("code",[t._v("undefined")]),t._v(".")]),t._v(" "),s("li",[t._v("If no sheet name is present in the string representation, returns "),s("code",[t._v("contextSheetId")]),t._v(" as sheet number.")])]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 0 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 5 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1!A6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns { sheet: 0, col: 0, row: 5 }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1!$A$6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns 'undefined', as there's no 'Sheet 2' in the HyperFormula instance")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet2!A6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("string representation of cell address in A1 notation")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("contextSheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SimpleCellAddress | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecelladdresstostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecelladdresstostring"}},[t._v("#")]),t._v(" simpleCellAddressToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellAddressToString")]),t._v("("),s("code",[t._v("cellAddress")]),t._v(": SimpleCellAddress, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2873",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2873"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns string representation of an absolute address in A1 notation or "),s("code",[t._v("undefined")]),t._v(" if the sheet index is not present in the engine.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if its arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'B2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Notation "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellAddress")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("object representation of an absolute address")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecellrangefromstring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecellrangefromstring"}},[t._v("#")]),t._v(" simpleCellRangeFromString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellRangeFromString")]),t._v("("),s("code",[t._v("cellRange")]),t._v(": string, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("SimpleCellRange | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2848",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2848"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes simple (absolute) address of a cell range based on its string representation.\nIf sheet name is present in string representation but not present in the engine, returns "),s("code",[t._v("undefined")]),t._v(".")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return { start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 0 } }")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1:A2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellRange")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("string representation of cell range in A1 notation")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("SimpleCellRange | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"simplecellrangetostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#simplecellrangetostring"}},[t._v("#")]),t._v(" simpleCellRangeToString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("simpleCellRangeToString")]),t._v("("),s("code",[t._v("cellRange")]),t._v(": SimpleCellRange, "),s("code",[t._v("sheetId")]),t._v(": number): "),s("em",[t._v("string | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2906",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2906"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns string representation of an absolute range in A1 notation or "),s("code",[t._v("undefined")]),t._v(" if the sheet index is not present in the engine.")]),t._v(" "),s("p",[t._v("Note: This method is useful only for cell ranges; does not work with column ranges and row ranges.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if its arguments are of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 0")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//sheetId = 1")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'B2:C2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Notation "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'Sheet1!B2:C2'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" another "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellRangeToString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("cellRange")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("object representation of an absolute range")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("sheetId")])]),t._v(" "),s("td",[t._v("number")]),t._v(" "),s("td",[t._v("context used in case of missing sheet in the first argument")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"validateformula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#validateformula"}},[t._v("#")]),t._v(" validateFormula")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("validateFormula")]),t._v("("),s("code",[t._v("formulaString")]),t._v(": string): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4163",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4163"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v('Validates the formula.\nIf the provided string starts with "=" and is a parsable formula, the method returns '),s("code",[t._v("true")]),t._v(".\nThe validation is purely grammatical: the method doesn't verify if the formula can be calculated or not.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// checks if the given string is a valid formula, should return 'true' for this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isFormula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("validateFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(1, 2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("formulaString")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v('a formula in a proper format - it must start with "="')])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"clipboard"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clipboard"}},[t._v("#")]),t._v(" Clipboard")]),t._v(" "),s("h3",{attrs:{id:"clearclipboard"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearclipboard"}},[t._v("#")]),t._v(" clearClipboard")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearClipboard")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2303",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2303"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the clipboard content.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clears the clipboard, isClipboardEmpty() should return true if called afterwards")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearClipboard")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"copy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#copy"}},[t._v("#")]),t._v(" copy")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("copy")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2167",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2167"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Stores a copy of the cell block in internal clipboard for the further paste.\nReturns the copied values for use in external clipboard.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// it copies [ [ 2 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangle range to copy")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"cut"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cut"}},[t._v("#")]),t._v(" cut")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("cut")]),t._v("("),s("code",[t._v("source")]),t._v(": SimpleCellRange): "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2205",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2205"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Stores information of the cell block in internal clipboard for further paste.\nCalling "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#paste"}},[t._v("paste")]),t._v(" right after this method is equivalent to call "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(".\nAlmost any CRUD operation called after this method will abort the cut operation.\nReturns the cut values for use in external clipboard.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if source is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns the values that were cut: [ [ 1 ] ]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("cut")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("source")])]),t._v(" "),s("td",[t._v("SimpleCellRange")]),t._v(" "),s("td",[t._v("rectangle range to cut")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("CellValue[][]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isclipboardempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isclipboardempty"}},[t._v("#")]),t._v(" isClipboardEmpty")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isClipboardEmpty")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2286",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2286"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns information whether there is something in the clipboard.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// copy desired content")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns 'false', there is content in the clipboard")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isClipboardEmpty "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isClipboardEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"paste"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#paste"}},[t._v("#")]),t._v(" paste")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("paste")]),t._v("("),s("code",[t._v("targetLeftCorner")]),t._v(": SimpleCellAddress): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2254",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2254"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("When called after "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#copy"}},[t._v("copy")]),t._v(" it pastes copied values and formulas into a cell block.\nWhen called after "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#cut"}},[t._v("cut")]),t._v(" it performs "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#movecells"}},[t._v("moveCells")]),t._v(" operation into the cell block.\nDoes nothing if the clipboard is empty.")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoSheetWithIdError]] when the given sheet ID does not exist")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[EvaluationSuspendedError]] when the evaluation is suspended")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NothingToPasteError]] when clipboard is empty")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[TargetLocationHasArrayError]] when the selected target area has array inside")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if targetLeftCorner is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [ [ 2 ] ] was copied")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" clipboardContent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("copy")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returns a list of modified cells: their absolute addresses and new values")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("paste")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The usage of the internal clipboard is described thoroughly in the "),s("RouterLink",{attrs:{to:"/guide/clipboard-operations.html"}},[t._v("Clipboard Operations guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("targetLeftCorner")])]),t._v(" "),s("td",[t._v("SimpleCellAddress")]),t._v(" "),s("td",[t._v("upper left address of the target cell block")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"undo-and-redo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#undo-and-redo"}},[t._v("#")]),t._v(" Undo and Redo")]),t._v(" "),s("h3",{attrs:{id:"clearredostack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearredostack"}},[t._v("#")]),t._v(" clearRedoStack")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearRedoStack")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2331",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2331"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the redo stack in undoRedo history.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do an operation, for example remove columns")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// redo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("redo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the redo stack")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearRedoStack")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"clearundostack"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearundostack"}},[t._v("#")]),t._v(" clearUndoStack")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("clearUndoStack")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L2356",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2356"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears the undo stack in undoRedo history.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do an operation, for example remove columns")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the undo stack")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearUndoStack")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"istheresomethingtoredo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#istheresomethingtoredo"}},[t._v("#")]),t._v(" isThereSomethingToRedo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isThereSomethingToRedo")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1155",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1155"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if there is at least one operation that can be re-done.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// when there is an action to redo, this returns 'true'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSomethingToRedo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isThereSomethingToRedo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"istheresomethingtoundo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#istheresomethingtoundo"}},[t._v("#")]),t._v(" isThereSomethingToUndo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isThereSomethingToUndo")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1138",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1138"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if there is at least one operation that can be undone.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return 'true', it is possible to undo last operation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// which is removing rows in this example")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isSomethingToUndo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isThereSomethingToUndo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"redo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#redo"}},[t._v("#")]),t._v(" redo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("redo")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1112",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1112"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Re-do recently undone operation.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoOperationToRedoError]] when there is no operation running that can be re-done")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation, it should return previous values: [['1'], ['2'], ['3']]")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// do a redo, it should return the values after removing the second row: [['1'], ['3']]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("redo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"undo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#undo"}},[t._v("#")]),t._v(" undo")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("undo")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L1076",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1076"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Undo the previous operation.")]),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of this operation")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[NoOperationToUndoError]] when there is no operation running that can be undone")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform CRUD operation, for example remove the second row")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// undo the operation, it should return the changes")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("undo")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"batch"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch"}},[t._v("#")]),t._v(" Batch")]),t._v(" "),s("h3",{attrs:{id:"batch-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch-2"}},[t._v("#")]),t._v(" batch")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("batch")]),t._v("("),s("code",[t._v("batchOperations")]),t._v(": function): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3463",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3463"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Runs the provided callback as a single "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch operation")]),t._v(" and returns the changed cells.")],1),t._v(" "),s("p",[t._v("Returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of all batched operations")]),t._v(".")],1),t._v(" "),s("p",[t._v("Note that this method may trigger dependency graph recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationsuspended"}},[t._v("evaluationSuspended")]),t._v(" always")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationresumed"}},[t._v("evaluationResumed")]),t._v(" after the recomputation of necessary values")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// multiple operations in a single callback will trigger evaluation only once")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// and only one set of changes is returned as a combined result of all")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the operations that were triggered within the callback")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("batch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("batchOperations")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[t._v("a function with operations to be performed")]),t._v(" "),s("p",[t._v("▸ (): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"isevaluationsuspended"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isevaluationsuspended"}},[t._v("#")]),t._v(" isEvaluationSuspended")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("isEvaluationSuspended")]),t._v("(): "),s("em",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3572",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3572"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if the dependency graph recalculation process is "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("suspended")]),t._v(" or not.")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend the evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// between suspendEvaluation() and resumeEvaluation()")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// or inside batch() callback it will return 'true', otherwise 'false'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isEvaluationSuspended "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isEvaluationSuspended")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"resumeevaluation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#resumeevaluation"}},[t._v("#")]),t._v(" resumeEvaluation")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("resumeEvaluation")]),t._v("(): "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3546",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3546"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Resumes the dependency graph recalculation that was "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("suspended")]),t._v(" with "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#suspendevaluation"}},[t._v("suspendEvaluation")]),t._v(".\nIt also triggers the recalculation and returns "),s("RouterLink",{attrs:{to:"/guide/basic-operations.html#changes-array"}},[t._v("an array of cells whose values changed as a result of all batched operations")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#valuesupdated"}},[t._v("valuesUpdated")]),t._v(" if recalculation was triggered by this change")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationresumed"}},[t._v("evaluationResumed")]),t._v(" after the recomputation of necessary values")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// similar to batch() but operations are not within a callback,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one method suspends the recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the second will resume calculations and return the changes")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first, suspend the evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform operations")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume the evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("ExportedChange[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"suspendevaluation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#suspendevaluation"}},[t._v("#")]),t._v(" suspendEvaluation")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("suspendEvaluation")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L3510",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3510"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Suspends the dependency graph recalculation to start a "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch operation")]),t._v(".\nIt allows optimizing the performance.\nWith this method, multiple CRUD operations can be done without triggering recalculation after every operation.\nSuspending evaluation should result in an overall faster calculation compared to recalculating after each operation separately.\nTo resume the evaluation use "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#resumeevaluation"}},[t._v("resumeEvaluation")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("fires")])]),t._v(" "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html#evaluationsuspended"}},[t._v("evaluationSuspended")]),t._v(" always")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// similar to batch() but operations are not within a callback,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one method suspends the recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the second will resume calculations and return the changes")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend the evaluation with this method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// perform operations")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use resumeEvaluation to resume")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"events"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" Events")]),t._v(" "),s("h3",{attrs:{id:"off"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("off")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4387"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unsubscribes from an event or from all events.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a simple function to be called upon emitting an event")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger an event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'baz' each time a sheet is added")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from a 'sheetAdded'")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet, the console should not print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"on"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("on")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4327",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4327"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Subscribes to an event.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass a simple handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'foo'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger an event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'foo' after each time sheet is added in this example")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"once"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("once")]),t._v("‹"),s("strong",[t._v("Event")]),t._v("›("),s("code",[t._v("event")]),t._v(": Event, "),s("code",[t._v("listener")]),t._v(": Listeners[Event]): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4353",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4353"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Subscribes to an event once.\nFor the list of all available events, see "),s("RouterLink",{attrs:{to:"/api/interfaces/listeners.html"}},[t._v("Listeners")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to a 'sheetAdded', pass a simple handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'foo'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// call addSheet twice,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// console should print 'foo' only once when the sheet is added in this example")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("p",[t._v("▪ "),s("strong",[t._v("Event")]),t._v(": "),s("em",[t._v("keyof Listeners")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("event")])]),t._v(" "),s("td",[t._v("Event")]),t._v(" "),s("td",[t._v("the name of the event to subscribe to")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("listener")])]),t._v(" "),s("td",[t._v("Listeners[Event]")]),t._v(" "),s("td",[t._v("to be called when event is emitted")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"custom-functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-functions"}},[t._v("#")]),t._v(" Custom Functions")]),t._v(" "),s("h3",{attrs:{id:"getallfunctionplugins"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallfunctionplugins"}},[t._v("#")]),t._v(" getAllFunctionPlugins")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllFunctionPlugins")]),t._v("(): "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4230",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4230"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns classes of all plugins registered in this instance of HyperFormula")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return classes of all plugins registered, assign to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllFunctionPlugins")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfunctionplugin"}},[t._v("#")]),t._v(" getFunctionPlugin")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFunctionPlugin")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4212",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4212"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns class of a plugin used by function with given id")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myPlugin "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("id of a function, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredfunctionnames"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredfunctionnames"}},[t._v("#")]),t._v(" getRegisteredFunctionNames")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredFunctionNames")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L4184",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4184"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns translated names of all functions registered in this instance of HyperFormula\naccording to the language set in the configuration")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return translated names of all functions, assign to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredFunctionNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"static-methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-methods"}},[t._v("#")]),t._v(" Static Methods")]),t._v(" "),s("h3",{attrs:{id:"getallfunctionplugins-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getallfunctionplugins-2"}},[t._v("#")]),t._v(" getAllFunctionPlugins "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getAllFunctionPlugins")]),t._v("(): "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:613"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns classes of all plugins registered in HyperFormula.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return classes of all plugins")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allClasses "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllFunctionPlugins")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getfunctionplugin-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getfunctionplugin-2"}},[t._v("#")]),t._v(" getFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getFunctionPlugin")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:597"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns class of a plugin used by function with given id")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return the class of a given plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myFunctionClass "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("id of a function, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("FunctionPluginDefinition | undefined")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getlanguage"}},[t._v("#")]),t._v(" getLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string): "),s("em",[t._v("TranslationPackage")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L348",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:348"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns registered language from its code string.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageNotRegisteredError]] when trying to retrieve not registered language")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return registered language")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" language "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enGB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("TranslationPackage")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredfunctionnames-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredfunctionnames-2"}},[t._v("#")]),t._v(" getRegisteredFunctionNames "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredFunctionNames")]),t._v("("),s("code",[t._v("code")]),t._v(": string): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L569",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:569"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns translated names of all registered functions for a given language")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return a list of function names registered for enGB")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" allNames "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredFunctionNames")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enGB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("code")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("language code")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"getregisteredlanguagescodes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getregisteredlanguagescodes"}},[t._v("#")]),t._v(" getRegisteredLanguagesCodes "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("getRegisteredLanguagesCodes")]),t._v("(): "),s("em",[t._v("string[]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:427"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Returns all registered languages codes.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// should return all registered language codes: ['enGB', 'plPL']")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" registeredLanguages "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRegisteredLanguagesCodes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("string[]")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerfunction"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerfunction"}},[t._v("#")]),t._v(" registerFunction "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerFunction")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string, "),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition, "),s("code",[t._v("translations?")]),t._v(": FunctionTranslationsPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L505",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:505"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers a function with a given id if such exists in a plugin.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("function id, e.g., 'SUMIF'")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("translations?")])]),t._v(" "),s("td",[t._v("FunctionTranslationsPackage")]),t._v(" "),s("td",[t._v("translations for the function name")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerfunctionplugin"}},[t._v("#")]),t._v(" registerFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerFunctionPlugin")]),t._v("("),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition, "),s("code",[t._v("translations?")]),t._v(": FunctionTranslationsPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L455",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:455"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers all functions in a given plugin with optional translations.")]),t._v(" "),s("p",[t._v("Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used.\nHyperFormula instances created prior to the registration of a FunctionPlugin are unable to access the FunctionPlugin.\nRegistering a FunctionPlugin with [[custom-functions]] requires the translations parameter.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register the plugin")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("translations?")])]),t._v(" "),s("td",[t._v("FunctionTranslationsPackage")]),t._v(" "),s("td",[t._v("optional package of function names translations")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"registerlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registerlanguage"}},[t._v("#")]),t._v(" registerLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("registerLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string, "),s("code",[t._v("languagePackage")]),t._v(": RawTranslationPackage): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L379",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:379"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Registers language under given code string.")]),t._v(" "),s("p",[t._v("For more information, see the "),s("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[t._v("Localizing functions guide")]),t._v(".")],1),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ProtectedFunctionTranslationError]] when trying to register translation for protected function")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageAlreadyRegisteredError]] when given language is already registered")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// return registered language")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enUS'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" enUS"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" engine "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("language")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'enUS'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("languagePackage")])]),t._v(" "),s("td",[t._v("RawTranslationPackage")]),t._v(" "),s("td",[t._v("translation package to be registered")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterallfunctions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterallfunctions"}},[t._v("#")]),t._v(" unregisterAllFunctions "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterAllFunctions")]),t._v("(): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L550",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:550"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Clears function registry.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterAllFunctions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterfunction"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterfunction"}},[t._v("#")]),t._v(" unregisterFunction "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterFunction")]),t._v("("),s("code",[t._v("functionId")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L533",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:533"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters a function with a given id.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import your own plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" MyExamplePlugin "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./file_with_your_plugin'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" MyExamplePlugin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister a function")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterFunction")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("functionId")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("function id, e.g., 'SUMIF'")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterfunctionplugin"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterfunctionplugin"}},[t._v("#")]),t._v(" unregisterFunctionPlugin "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterFunctionPlugin")]),t._v("("),s("code",[t._v("plugin")]),t._v(": FunctionPluginDefinition): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:477"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters all functions defined in given plugin.")]),t._v(" "),s("p",[t._v("Note: This method does not affect the existing HyperFormula instances.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the class of a plugin")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" registeredPluginClass "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'EXAMPLE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister all functions defined in a plugin of ID 'EXAMPLE'")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterFunctionPlugin")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("registeredPluginClass"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("plugin")])]),t._v(" "),s("td",[t._v("FunctionPluginDefinition")]),t._v(" "),s("td",[t._v("plugin class")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"unregisterlanguage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#unregisterlanguage"}},[t._v("#")]),t._v(" unregisterLanguage "),s("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("unregisterLanguage")]),t._v("("),s("code",[t._v("languageCode")]),t._v(": string): "),s("em",[t._v("void")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/HyperFormula.ts#L407",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:407"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Unregisters language that is registered under given code string.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("throws")])]),t._v(" [[LanguageNotRegisteredError]] when given language is not registered")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// register the language for the instance")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("registerLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'plPL'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" plPL"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unregister plPL")]),t._v("\nHyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("unregisterLanguage")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'plPL'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("languageCode")])]),t._v(" "),s("td",[t._v("string")]),t._v(" "),s("td",[t._v("code string of the translation package")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("em",[t._v("void")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/29.d2c15be1.js b/assets/js/29.bff45b76.js similarity index 86% rename from assets/js/29.d2c15be1.js rename to assets/js/29.bff45b76.js index c59a259b7..8690919ae 100644 --- a/assets/js/29.d2c15be1.js +++ b/assets/js/29.bff45b76.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{319:function(e,t,r){"use strict";r.r(t);var a=r(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"events"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[e._v("#")]),e._v(" Events "),t("Badge",{attrs:{text:"Enumeration"}})],1),e._v(" "),t("h2",{attrs:{id:"enumeration-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[e._v("#")]),e._v(" Enumeration members")]),e._v(" "),t("h3",{attrs:{id:"evaluationresumed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluationresumed"}},[e._v("#")]),e._v(" EvaluationResumed")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("EvaluationResumed")]),e._v(': = "evaluationResumed"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:17"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"evaluationsuspended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluationsuspended"}},[e._v("#")]),e._v(" EvaluationSuspended")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("EvaluationSuspended")]),e._v(': = "evaluationSuspended"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:16"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"namedexpressionadded"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionadded"}},[e._v("#")]),e._v(" NamedExpressionAdded")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("NamedExpressionAdded")]),e._v(': = "namedExpressionAdded"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:13"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"namedexpressionremoved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionremoved"}},[e._v("#")]),e._v(" NamedExpressionRemoved")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("NamedExpressionRemoved")]),e._v(': = "namedExpressionRemoved"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetadded"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetadded"}},[e._v("#")]),e._v(" SheetAdded")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetAdded")]),e._v(': = "sheetAdded"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:10"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetremoved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetremoved"}},[e._v("#")]),e._v(" SheetRemoved")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetRemoved")]),e._v(': = "sheetRemoved"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:11"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetrenamed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetrenamed"}},[e._v("#")]),e._v(" SheetRenamed")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetRenamed")]),e._v(': = "sheetRenamed"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:12"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"valuesupdated"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#valuesupdated"}},[e._v("#")]),e._v(" ValuesUpdated")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ValuesUpdated")]),e._v(': = "valuesUpdated"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:15"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{322:function(e,t,r){"use strict";r.r(t);var a=r(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"events"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[e._v("#")]),e._v(" Events "),t("Badge",{attrs:{text:"Enumeration"}})],1),e._v(" "),t("h2",{attrs:{id:"enumeration-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[e._v("#")]),e._v(" Enumeration members")]),e._v(" "),t("h3",{attrs:{id:"evaluationresumed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluationresumed"}},[e._v("#")]),e._v(" EvaluationResumed")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("EvaluationResumed")]),e._v(': = "evaluationResumed"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:17"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"evaluationsuspended"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluationsuspended"}},[e._v("#")]),e._v(" EvaluationSuspended")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("EvaluationSuspended")]),e._v(': = "evaluationSuspended"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:16"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"namedexpressionadded"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionadded"}},[e._v("#")]),e._v(" NamedExpressionAdded")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("NamedExpressionAdded")]),e._v(': = "namedExpressionAdded"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:13"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"namedexpressionremoved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionremoved"}},[e._v("#")]),e._v(" NamedExpressionRemoved")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("NamedExpressionRemoved")]),e._v(': = "namedExpressionRemoved"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetadded"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetadded"}},[e._v("#")]),e._v(" SheetAdded")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetAdded")]),e._v(': = "sheetAdded"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:10"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetremoved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetremoved"}},[e._v("#")]),e._v(" SheetRemoved")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetRemoved")]),e._v(': = "sheetRemoved"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:11"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sheetrenamed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sheetrenamed"}},[e._v("#")]),e._v(" SheetRenamed")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("SheetRenamed")]),e._v(': = "sheetRenamed"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:12"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"valuesupdated"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#valuesupdated"}},[e._v("#")]),e._v(" ValuesUpdated")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ValuesUpdated")]),e._v(': = "valuesUpdated"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Emitter.ts:15"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/30.845910cf.js b/assets/js/30.70774167.js similarity index 94% rename from assets/js/30.845910cf.js rename to assets/js/30.70774167.js index 716ea14e3..39acc0f08 100644 --- a/assets/js/30.845910cf.js +++ b/assets/js/30.70774167.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{323:function(e,a,r){"use strict";r.r(a);var t=r(14),s=Object(t.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"api-reference-overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api-reference-overview"}},[e._v("#")]),e._v(" API Reference Overview")]),e._v(" "),a("h2",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("h3",{attrs:{id:"configparamslist"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configparamslist"}},[e._v("#")]),e._v(" ConfigParamsList")]),e._v(" "),a("p",[e._v("Ƭ "),a("strong",[e._v("ConfigParamsList")]),e._v(": "),a("em",[e._v("keyof ConfigParams")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L402",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:402"),a("OutboundLink")],1)])])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{323:function(e,a,r){"use strict";r.r(a);var t=r(14),s=Object(t.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"api-reference-overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api-reference-overview"}},[e._v("#")]),e._v(" API Reference Overview")]),e._v(" "),a("h2",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("h3",{attrs:{id:"configparamslist"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configparamslist"}},[e._v("#")]),e._v(" ConfigParamsList")]),e._v(" "),a("p",[e._v("Ƭ "),a("strong",[e._v("ConfigParamsList")]),e._v(": "),a("em",[e._v("keyof ConfigParams")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L402",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:402"),a("OutboundLink")],1)])])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/31.edb78418.js b/assets/js/31.4842ae45.js similarity index 93% rename from assets/js/31.edb78418.js rename to assets/js/31.4842ae45.js index ee164153f..b2357ecaa 100644 --- a/assets/js/31.edb78418.js +++ b/assets/js/31.4842ae45.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{326:function(e,t,r){"use strict";r.r(t);var a=r(14),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"configparams"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configparams"}},[e._v("#")]),e._v(" ConfigParams "),t("Badge",{attrs:{text:"Interface"}})],1),e._v(" "),t("h2",{attrs:{id:"license"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#license"}},[e._v("#")]),e._v(" License")]),e._v(" "),t("h3",{attrs:{id:"licensekey"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licensekey"}},[e._v("#")]),e._v(" licenseKey")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("licenseKey")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L175",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:175"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets your HyperFormula license key.")]),e._v(" "),t("p",[e._v("To use HyperFormula on the GPLv3 license terms, set this option to "),t("code",[e._v("gpl-v3")]),e._v(".")]),e._v(" "),t("p",[e._v("To use HyperFormula with your commercial license, set this option to your valid license key string.")]),e._v(" "),t("p",[e._v("For more information, go "),t("RouterLink",{attrs:{to:"/guide/license-key.html"}},[e._v("here")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" undefined")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"engine"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#engine"}},[e._v("#")]),e._v(" Engine")]),e._v(" "),t("h3",{attrs:{id:"binarysearchthreshold"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#binarysearchthreshold"}},[e._v("#")]),e._v(" binarySearchThreshold")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("binarySearchThreshold")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:25"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a minimum number of elements that a range must have to use binary search.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("deprecated")])]),e._v(" Every search of sorted data always uses binary search.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 20")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"chooseaddressmappingpolicy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chooseaddressmappingpolicy"}},[e._v("#")]),e._v(" chooseAddressMappingPolicy")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("chooseAddressMappingPolicy")]),e._v(": "),t("em",[e._v("ChooseAddressMapping")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:54"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the address mapping policy to be used.")]),e._v(" "),t("p",[e._v("Built-in implementations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("DenseSparseChooseBasedOnThreshold")]),e._v(": sets the address mapping policy separately for each sheet, based on fill ratio.")]),e._v(" "),t("li",[t("code",[e._v("AlwaysDense")]),e._v(": uses "),t("code",[e._v("DenseStrategy")]),e._v(" for all sheets.")]),e._v(" "),t("li",[t("code",[e._v("AlwaysSparse")]),e._v(": uses "),t("code",[e._v("SparseStrategy")]),e._v(" for all sheets.")])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" AlwaysDense")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"context"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#context"}},[e._v("#")]),e._v(" context")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("context")]),e._v(": "),t("em",[e._v("unknown")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:60"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("A generic parameter that can be used to pass data to custom functions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" undefined")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"evaluatenulltozero"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluatenulltozero"}},[e._v("#")]),e._v(" evaluateNullToZero")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("evaluateNullToZero")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:122"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", formulas evaluating to "),t("code",[e._v("null")]),e._v(" evaluate to "),t("code",[e._v("0")]),e._v(" instead.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"maxcolumns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxcolumns"}},[e._v("#")]),e._v(" maxColumns")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("maxColumns")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L217",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:217"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the maximum number of columns.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 18.278 (Columns A, B, ..., ZZZ)")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"maxrows"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxrows"}},[e._v("#")]),e._v(" maxRows")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("maxRows")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L211",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:211"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the maximum number of rows.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 40.000")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usearrayarithmetic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usearrayarithmetic"}},[e._v("#")]),e._v(" useArrayArithmetic")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useArrayArithmetic")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L363",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:363"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", array arithmetic is enabled globally.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", array arithmetic is enabled only inside array functions ("),t("code",[e._v("ARRAYFORMULA")]),e._v(", "),t("code",[e._v("FILTER")]),e._v(", and "),t("code",[e._v("ARRAY_CONSTRAIN")]),e._v(").")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/arrays.html"}},[e._v("Arrays guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usecolumnindex"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usecolumnindex"}},[e._v("#")]),e._v(" useColumnIndex")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useColumnIndex")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L373",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:373"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", switches column search strategy from binary search to column index.")]),e._v(" "),t("p",[e._v("Using column index improves efficiency of the "),t("code",[e._v("VLOOKUP")]),e._v(" and "),t("code",[e._v("MATCH")]),e._v(" functions, but increases memory usage.")]),e._v(" "),t("p",[e._v("When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with "),t("code",[e._v("useColumnIndex")]),e._v(" set to "),t("code",[e._v("true")]),e._v(").")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usestats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usestats"}},[e._v("#")]),e._v(" useStats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useStats")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L381",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:381"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", enables gathering engine statistics and timings.")]),e._v(" "),t("p",[e._v("Useful for testing and benchmarking.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"formula-syntax"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#formula-syntax"}},[e._v("#")]),e._v(" Formula Syntax")]),e._v(" "),t("h3",{attrs:{id:"arraycolumnseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arraycolumnseparator"}},[e._v("#")]),e._v(" arrayColumnSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayColumnSeparator")]),e._v(": "),t("em",[e._v('"," | ";"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:199"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a column separator symbol for array notation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ','")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"arrayrowseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arrayrowseparator"}},[e._v("#")]),e._v(" arrayRowSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayRowSeparator")]),e._v(": "),t("em",[e._v('";" | "|"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:205"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a row separator symbol for array notation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ';'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"functionargseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionargseparator"}},[e._v("#")]),e._v(" functionArgSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionArgSeparator")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:102"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a separator character that separates procedure arguments in formulas.")]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#thousandseparator"}},[e._v("thousandSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ','")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"functionplugins"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionplugins"}},[e._v("#")]),e._v(" functionPlugins")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionPlugins")]),e._v(": "),t("em",[e._v("any[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:129"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Lists additional function plugins to be used by the formula interpreter.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" []")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"ignorewhitespace"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorewhitespace"}},[e._v("#")]),e._v(" ignoreWhiteSpace")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignoreWhiteSpace")]),e._v(": "),t("em",[e._v('"standard" | "any"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:153"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Controls the set of whitespace characters that are allowed inside a formula.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("'standard'")]),e._v(", allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("'any'")]),e._v(", allows all whitespace characters that would be captured by the "),t("code",[e._v("\\s")]),e._v(" character class of the JavaScript regular expressions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'standard'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"language"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#language"}},[e._v("#")]),e._v(" language")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("language")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:143"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a translation package for function and error names.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[e._v("Localizing functions guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'enGB'")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"undo-and-redo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undo-and-redo"}},[e._v("#")]),e._v(" Undo and Redo")]),e._v(" "),t("h3",{attrs:{id:"undolimit"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undolimit"}},[e._v("#")]),e._v(" undoLimit")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("undoLimit")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L387",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:387"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the number of elements kept in the undo history.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 20")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"date-and-time"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#date-and-time"}},[e._v("#")]),e._v(" Date and Time")]),e._v(" "),t("h3",{attrs:{id:"dateformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dateformats"}},[e._v("#")]),e._v(" dateFormats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("dateFormats")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:92"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the date formats accepted by the date-parsing function.")]),e._v(" "),t("p",[e._v("A format must be specified as a string consisting of tokens and separators.")]),e._v(" "),t("p",[e._v("Supported tokens:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("DD")]),e._v(" (day of month)")]),e._v(" "),t("li",[t("code",[e._v("MM")]),e._v(" (month as a number)")]),e._v(" "),t("li",[t("code",[e._v("YYYY")]),e._v(" (year as a 4-digit number)")]),e._v(" "),t("li",[t("code",[e._v("YY")]),e._v(" (year as a 2-digit number)")])]),e._v(" "),t("p",[e._v("Supported separators:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("/")]),e._v(" (slash)")]),e._v(" "),t("li",[t("code",[e._v("-")]),e._v(" (dash)")]),e._v(" "),t("li",[t("code",[e._v(".")]),e._v(" (dot)")]),e._v(" "),t("li",[t("code"),e._v(" (empty space)")])]),e._v(" "),t("p",[e._v("Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['DD/MM/YYYY', 'DD/MM/YY']")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"leapyear1900"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#leapyear1900"}},[e._v("#")]),e._v(" leapYear1900")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("leapYear1900")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:163"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets year 1900 as a leap year.")]),e._v(" "),t("p",[e._v("For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to "),t("code",[e._v("true")]),e._v(".")]),e._v(" "),t("p",[e._v("For more information, see "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#nulldate"}},[e._v("nullDate")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"nulldate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nulldate"}},[e._v("#")]),e._v(" nullDate")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("nullDate")]),e._v(": "),t("em",[e._v("SimpleDate")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L227",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:227"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Internally, each date is represented as a number of days that passed since "),t("code",[e._v("nullDate")]),e._v(".")]),e._v(" "),t("p",[e._v("This option sets a specific date from which that number of days is counted.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" {year: 1899, month: 12, day: 30}")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"nullyear"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nullyear"}},[e._v("#")]),e._v(" nullYear")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("nullYear")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L239",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:239"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the interpretation of two-digit year values.")]),e._v(" "),t("p",[e._v("Two-digit year values ("),t("code",[e._v("xx")]),e._v(") can either become "),t("code",[e._v("19xx")]),e._v(" or "),t("code",[e._v("20xx")]),e._v(".")]),e._v(" "),t("p",[e._v("If "),t("code",[e._v("xx")]),e._v(" is less or equal to "),t("code",[e._v("nullYear")]),e._v(", two-digit year values become "),t("code",[e._v("20xx")]),e._v(".")]),e._v(" "),t("p",[e._v("If "),t("code",[e._v("xx")]),e._v(" is more than "),t("code",[e._v("nullYear")]),e._v(", two-digit year values become "),t("code",[e._v("19xx")]),e._v(".")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 30")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"parsedatetime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsedatetime"}},[e._v("#")]),e._v(" parseDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("parseDateTime")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L249",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:249"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that parses strings representing date-time into actual date-time values.")]),e._v(" "),t("p",[e._v("The function should return a "),t("RouterLink",{attrs:{to:"/api/globals.html#datetime"}},[e._v("DateTime")]),e._v(" object or undefined.")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultParseToDateTime")]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("dateTimeString")]),e._v(": string, "),t("code",[e._v("dateFormat?")]),e._v(": undefined | string, "),t("code",[e._v("timeFormat?")]),e._v(": undefined | string): "),t("em",[e._v("Maybe‹DateTime›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("dateTimeString")])]),e._v(" "),t("td",[e._v("string")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("dateFormat?")])]),e._v(" "),t("td",[e._v("undefined | string")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("timeFormat?")])]),e._v(" "),t("td",[e._v("undefined | string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"stringifydatetime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifydatetime"}},[e._v("#")]),e._v(" stringifyDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDateTime")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L289",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:289"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that converts date-time values into strings.")]),e._v(" "),t("p",[e._v("The function should return a string or undefined.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultStringifyDateTime")]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("dateTime")]),e._v(": SimpleDateTime, "),t("code",[e._v("dateTimeFormat")]),e._v(": string): "),t("em",[e._v("Maybe‹string›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("dateTime")])]),e._v(" "),t("td",[e._v("SimpleDateTime")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("dateTimeFormat")])]),e._v(" "),t("td",[e._v("string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"stringifyduration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifyduration"}},[e._v("#")]),e._v(" stringifyDuration")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDuration")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L299",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:299"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that converts time duration values into strings.")]),e._v(" "),t("p",[e._v("The function should return a string or undefined.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultStringifyDuration")]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("time")]),e._v(": SimpleTime, "),t("code",[e._v("timeFormat")]),e._v(": string): "),t("em",[e._v("Maybe‹string›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("time")])]),e._v(" "),t("td",[e._v("SimpleTime")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("timeFormat")])]),e._v(" "),t("td",[e._v("string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"timeformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#timeformats"}},[e._v("#")]),e._v(" timeFormats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("timeFormats")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L353",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:353"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the time formats accepted by the time-parsing function.")]),e._v(" "),t("p",[e._v("A format must be specified as a string consisting of at least two tokens separated by "),t("code",[e._v(":")]),e._v(" (a colon).")]),e._v(" "),t("p",[e._v("Supported tokens:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("hh")]),e._v(" (hours)")]),e._v(" "),t("li",[t("code",[e._v("mm")]),e._v(" (minutes)")]),e._v(" "),t("li",[t("code",[e._v("ss")]),e._v(", "),t("code",[e._v("ss.s")]),e._v(", "),t("code",[e._v("ss.ss")]),e._v(", "),t("code",[e._v("ss.sss")]),e._v(", "),t("code",[e._v("ss.ssss")]),e._v(", etc. (seconds)")])]),e._v(" "),t("p",[e._v("The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values.\nRegardless of the time format specified, the hours-minutes-seconds value may be followed by the AM/PM designator.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("example")])]),e._v("\nE.g., for "),t("code",[e._v("timeFormats = ['hh:mm:ss.sss']")]),e._v(", valid time strings include:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("1:33:33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.3")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.333")])]),e._v(" "),t("li",[t("code",[e._v("01:33:33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 AM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 PM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 am")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 pm")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33AM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33PM")])])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['hh:mm', 'hh:mm:ss.sss']")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"number"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#number"}},[e._v("#")]),e._v(" Number")]),e._v(" "),t("h3",{attrs:{id:"currencysymbol"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#currencysymbol"}},[e._v("#")]),e._v(" currencySymbol")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("currencySymbol")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:68"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets symbols that denote currency numbers.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['$']")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"decimalseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decimalseparator"}},[e._v("#")]),e._v(" decimalSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("decimalSeparator")]),e._v(": "),t("em",[e._v('"." | ","')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:116"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a decimal separator used for parsing numerical literals.")]),e._v(" "),t("p",[e._v("Can be one of the following:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v(".")]),e._v(" (period)")]),e._v(" "),t("li",[t("code",[e._v(",")]),e._v(" (comma)")])]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#thousandseparator"}},[e._v("thousandSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#functionargseparator"}},[e._v("functionArgSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" '.'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"precisionepsilon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionepsilon"}},[e._v("#")]),e._v(" precisionEpsilon")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("precisionEpsilon")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L264",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:264"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets how far two numerical values need to be from each other to be treated as non-equal.")]),e._v(" "),t("p",[t("code",[e._v("a")]),e._v(" and "),t("code",[e._v("b")]),e._v(" are equal if all three of the following conditions are met:")]),e._v(" "),t("ul",[t("li",[e._v("Both "),t("code",[e._v("a")]),e._v(" and "),t("code",[e._v("b")]),e._v(" are of the same sign")]),e._v(" "),t("li",[t("code",[e._v("abs(a)")]),e._v(" <= "),t("code",[e._v("(1+precisionEpsilon) * abs(b)")])]),e._v(" "),t("li",[t("code",[e._v("abs(b)")]),e._v(" <= "),t("code",[e._v("(1+precisionEpsilon) * abs(a)")])])]),e._v(" "),t("p",[e._v("Additionally, this option controls the snap-to-zero behavior for additions and subtractions:")]),e._v(" "),t("ul",[t("li",[e._v("For "),t("code",[e._v("c=a+b")]),e._v(", if "),t("code",[e._v("abs(c)")]),e._v(" <= "),t("code",[e._v("precisionEpsilon * abs(a)")]),e._v(", then "),t("code",[e._v("c")]),e._v(" is set to "),t("code",[e._v("0")])]),e._v(" "),t("li",[e._v("For "),t("code",[e._v("c=a-b")]),e._v(", if "),t("code",[e._v("abs(c)")]),e._v(" <= "),t("code",[e._v("precisionEpsilon * abs(a)")]),e._v(", then "),t("code",[e._v("c")]),e._v(" is set to "),t("code",[e._v("0")])])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 1e-13")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"precisionrounding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionrounding"}},[e._v("#")]),e._v(" precisionRounding")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("precisionRounding")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L279",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:279"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the precision level of calculations' output.")]),e._v(" "),t("p",[e._v("Internally, all arithmetic operations are performed using JavaScript's built-in numbers.\nBut when HyperFormula exports a cell's value, it rounds the output\nto the "),t("code",[e._v("precisionRounding")]),e._v(" number of significant digits.")]),e._v(" "),t("p",[e._v("Setting "),t("code",[e._v("precisionRounding")]),e._v(" too low can cause large numbers' imprecision\n(for example, with "),t("code",[e._v("precisionRounding")]),e._v(" set to "),t("code",[e._v("4")]),e._v(", 100005 becomes 100010).")]),e._v(" "),t("p",[e._v("We recommend setting "),t("code",[e._v("precisionRounding")]),e._v(" to a value between "),t("code",[e._v("10")]),e._v(" and "),t("code",[e._v("14")]),e._v(".")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 14")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"smartrounding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#smartrounding"}},[e._v("#")]),e._v(" smartRounding")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("smartRounding")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L307",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:307"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", no rounding happens, and numbers are equal if and only if they are of truly identical value.")]),e._v(" "),t("p",[e._v("For more information, see "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#precisionepsilon"}},[e._v("precisionEpsilon")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"thousandseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#thousandseparator"}},[e._v("#")]),e._v(" thousandSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("thousandSeparator")]),e._v(": "),t("em",[e._v('"" | "," | " " | "."')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L322",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:322"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the thousands' separator symbol for parsing numerical literals.")]),e._v(" "),t("p",[e._v("Can be one of the following:")]),e._v(" "),t("ul",[t("li",[e._v("empty")]),e._v(" "),t("li",[t("code",[e._v(",")]),e._v(" (comma)")]),e._v(" "),t("li",[t("code"),e._v(" (empty space)")])]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#functionargseparator"}},[e._v("functionArgSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ''")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"string"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#string"}},[e._v("#")]),e._v(" String")]),e._v(" "),t("h3",{attrs:{id:"accentsensitive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accentsensitive"}},[e._v("#")]),e._v(" accentSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("accentSensitive")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", makes string comparison accent-sensitive.")]),e._v(" "),t("p",[e._v("Applies only to comparison operators.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"casefirst"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casefirst"}},[e._v("#")]),e._v(" caseFirst")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseFirst")]),e._v(": "),t("em",[e._v('"upper" | "lower" | "false"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:43"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("upper")]),e._v(", upper case sorts first.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("lower")]),e._v(", lower case sorts first.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", uses the locale's default.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'lower'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"casesensitive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casesensitive"}},[e._v("#")]),e._v(" caseSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseSensitive")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:33"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", makes string comparison case-sensitive.")]),e._v(" "),t("p",[e._v("Applies to comparison operators only.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"ignorepunctuation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorepunctuation"}},[e._v("#")]),e._v(" ignorePunctuation")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignorePunctuation")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:135"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", string comparison ignores punctuation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"localelang"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#localelang"}},[e._v("#")]),e._v(" localeLang")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("localeLang")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L185",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:185"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the locale for language-sensitive string comparison.")]),e._v(" "),t("p",[e._v("Accepts "),t("strong",[e._v("IETF BCP 47")]),e._v(" language tags.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'en'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"matchwholecell"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#matchwholecell"}},[e._v("#")]),e._v(" matchWholeCell")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("matchWholeCell")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L193",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:193"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", function criteria require whole cells to match the pattern.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", function criteria require just a sub-word to match the pattern.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"useregularexpressions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#useregularexpressions"}},[e._v("#")]),e._v(" useRegularExpressions")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useRegularExpressions")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L393",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:393"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usewildcards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usewildcards"}},[e._v("#")]),e._v(" useWildcards")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useWildcards")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/ConfigParams.ts#L399",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:399"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", criteria in functions (SUMIF, COUNTIF, ...) can use the "),t("code",[e._v("*")]),e._v(" and "),t("code",[e._v("?")]),e._v(" wildcards.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{325:function(e,t,a){"use strict";a.r(t);var r=a(14),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"configparams"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configparams"}},[e._v("#")]),e._v(" ConfigParams "),t("Badge",{attrs:{text:"Interface"}})],1),e._v(" "),t("h2",{attrs:{id:"license"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#license"}},[e._v("#")]),e._v(" License")]),e._v(" "),t("h3",{attrs:{id:"licensekey"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licensekey"}},[e._v("#")]),e._v(" licenseKey")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("licenseKey")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L175",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:175"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets your HyperFormula license key.")]),e._v(" "),t("p",[e._v("To use HyperFormula on the GPLv3 license terms, set this option to "),t("code",[e._v("gpl-v3")]),e._v(".")]),e._v(" "),t("p",[e._v("To use HyperFormula with your commercial license, set this option to your valid license key string.")]),e._v(" "),t("p",[e._v("For more information, go "),t("RouterLink",{attrs:{to:"/guide/license-key.html"}},[e._v("here")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" undefined")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"engine"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#engine"}},[e._v("#")]),e._v(" Engine")]),e._v(" "),t("h3",{attrs:{id:"binarysearchthreshold"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#binarysearchthreshold"}},[e._v("#")]),e._v(" binarySearchThreshold")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("binarySearchThreshold")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:25"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a minimum number of elements that a range must have to use binary search.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("deprecated")])]),e._v(" Every search of sorted data always uses binary search.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 20")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"chooseaddressmappingpolicy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chooseaddressmappingpolicy"}},[e._v("#")]),e._v(" chooseAddressMappingPolicy")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("chooseAddressMappingPolicy")]),e._v(": "),t("em",[e._v("ChooseAddressMapping")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:54"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the address mapping policy to be used.")]),e._v(" "),t("p",[e._v("Built-in implementations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("DenseSparseChooseBasedOnThreshold")]),e._v(": sets the address mapping policy separately for each sheet, based on fill ratio.")]),e._v(" "),t("li",[t("code",[e._v("AlwaysDense")]),e._v(": uses "),t("code",[e._v("DenseStrategy")]),e._v(" for all sheets.")]),e._v(" "),t("li",[t("code",[e._v("AlwaysSparse")]),e._v(": uses "),t("code",[e._v("SparseStrategy")]),e._v(" for all sheets.")])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" AlwaysDense")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"context"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#context"}},[e._v("#")]),e._v(" context")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("context")]),e._v(": "),t("em",[e._v("unknown")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:60"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("A generic parameter that can be used to pass data to custom functions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" undefined")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"evaluatenulltozero"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluatenulltozero"}},[e._v("#")]),e._v(" evaluateNullToZero")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("evaluateNullToZero")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:122"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", formulas evaluating to "),t("code",[e._v("null")]),e._v(" evaluate to "),t("code",[e._v("0")]),e._v(" instead.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"maxcolumns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxcolumns"}},[e._v("#")]),e._v(" maxColumns")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("maxColumns")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L217",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:217"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the maximum number of columns.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 18.278 (Columns A, B, ..., ZZZ)")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"maxrows"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxrows"}},[e._v("#")]),e._v(" maxRows")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("maxRows")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L211",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:211"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the maximum number of rows.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 40.000")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usearrayarithmetic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usearrayarithmetic"}},[e._v("#")]),e._v(" useArrayArithmetic")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useArrayArithmetic")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L363",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:363"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", array arithmetic is enabled globally.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", array arithmetic is enabled only inside array functions ("),t("code",[e._v("ARRAYFORMULA")]),e._v(", "),t("code",[e._v("FILTER")]),e._v(", and "),t("code",[e._v("ARRAY_CONSTRAIN")]),e._v(").")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/arrays.html"}},[e._v("Arrays guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usecolumnindex"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usecolumnindex"}},[e._v("#")]),e._v(" useColumnIndex")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useColumnIndex")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L373",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:373"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", switches column search strategy from binary search to column index.")]),e._v(" "),t("p",[e._v("Using column index improves efficiency of the "),t("code",[e._v("VLOOKUP")]),e._v(" and "),t("code",[e._v("MATCH")]),e._v(" functions, but increases memory usage.")]),e._v(" "),t("p",[e._v("When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with "),t("code",[e._v("useColumnIndex")]),e._v(" set to "),t("code",[e._v("true")]),e._v(").")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usestats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usestats"}},[e._v("#")]),e._v(" useStats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useStats")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L381",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:381"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", enables gathering engine statistics and timings.")]),e._v(" "),t("p",[e._v("Useful for testing and benchmarking.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"formula-syntax"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#formula-syntax"}},[e._v("#")]),e._v(" Formula Syntax")]),e._v(" "),t("h3",{attrs:{id:"arraycolumnseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arraycolumnseparator"}},[e._v("#")]),e._v(" arrayColumnSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayColumnSeparator")]),e._v(": "),t("em",[e._v('"," | ";"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:199"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a column separator symbol for array notation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ','")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"arrayrowseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arrayrowseparator"}},[e._v("#")]),e._v(" arrayRowSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayRowSeparator")]),e._v(": "),t("em",[e._v('";" | "|"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:205"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a row separator symbol for array notation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ';'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"functionargseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionargseparator"}},[e._v("#")]),e._v(" functionArgSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionArgSeparator")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:102"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a separator character that separates procedure arguments in formulas.")]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#thousandseparator"}},[e._v("thousandSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ','")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"functionplugins"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionplugins"}},[e._v("#")]),e._v(" functionPlugins")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionPlugins")]),e._v(": "),t("em",[e._v("any[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:129"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Lists additional function plugins to be used by the formula interpreter.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" []")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"ignorewhitespace"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorewhitespace"}},[e._v("#")]),e._v(" ignoreWhiteSpace")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignoreWhiteSpace")]),e._v(": "),t("em",[e._v('"standard" | "any"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:153"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Controls the set of whitespace characters that are allowed inside a formula.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("'standard'")]),e._v(", allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("'any'")]),e._v(", allows all whitespace characters that would be captured by the "),t("code",[e._v("\\s")]),e._v(" character class of the JavaScript regular expressions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'standard'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"language"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#language"}},[e._v("#")]),e._v(" language")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("language")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:143"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a translation package for function and error names.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/localizing-functions.html"}},[e._v("Localizing functions guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'enGB'")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"undo-and-redo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undo-and-redo"}},[e._v("#")]),e._v(" Undo and Redo")]),e._v(" "),t("h3",{attrs:{id:"undolimit"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undolimit"}},[e._v("#")]),e._v(" undoLimit")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("undoLimit")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L387",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:387"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the number of elements kept in the undo history.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 20")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"date-and-time"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#date-and-time"}},[e._v("#")]),e._v(" Date and Time")]),e._v(" "),t("h3",{attrs:{id:"dateformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dateformats"}},[e._v("#")]),e._v(" dateFormats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("dateFormats")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:92"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the date formats accepted by the date-parsing function.")]),e._v(" "),t("p",[e._v("A format must be specified as a string consisting of tokens and separators.")]),e._v(" "),t("p",[e._v("Supported tokens:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("DD")]),e._v(" (day of month)")]),e._v(" "),t("li",[t("code",[e._v("MM")]),e._v(" (month as a number)")]),e._v(" "),t("li",[t("code",[e._v("YYYY")]),e._v(" (year as a 4-digit number)")]),e._v(" "),t("li",[t("code",[e._v("YY")]),e._v(" (year as a 2-digit number)")])]),e._v(" "),t("p",[e._v("Supported separators:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("/")]),e._v(" (slash)")]),e._v(" "),t("li",[t("code",[e._v("-")]),e._v(" (dash)")]),e._v(" "),t("li",[t("code",[e._v(".")]),e._v(" (dot)")]),e._v(" "),t("li",[t("code"),e._v(" (empty space)")])]),e._v(" "),t("p",[e._v("Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['DD/MM/YYYY', 'DD/MM/YY']")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"leapyear1900"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#leapyear1900"}},[e._v("#")]),e._v(" leapYear1900")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("leapYear1900")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:163"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets year 1900 as a leap year.")]),e._v(" "),t("p",[e._v("For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to "),t("code",[e._v("true")]),e._v(".")]),e._v(" "),t("p",[e._v("For more information, see "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#nulldate"}},[e._v("nullDate")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"nulldate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nulldate"}},[e._v("#")]),e._v(" nullDate")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("nullDate")]),e._v(": "),t("em",[e._v("SimpleDate")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L227",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:227"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Internally, each date is represented as a number of days that passed since "),t("code",[e._v("nullDate")]),e._v(".")]),e._v(" "),t("p",[e._v("This option sets a specific date from which that number of days is counted.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" {year: 1899, month: 12, day: 30}")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"nullyear"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nullyear"}},[e._v("#")]),e._v(" nullYear")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("nullYear")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L239",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:239"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the interpretation of two-digit year values.")]),e._v(" "),t("p",[e._v("Two-digit year values ("),t("code",[e._v("xx")]),e._v(") can either become "),t("code",[e._v("19xx")]),e._v(" or "),t("code",[e._v("20xx")]),e._v(".")]),e._v(" "),t("p",[e._v("If "),t("code",[e._v("xx")]),e._v(" is less or equal to "),t("code",[e._v("nullYear")]),e._v(", two-digit year values become "),t("code",[e._v("20xx")]),e._v(".")]),e._v(" "),t("p",[e._v("If "),t("code",[e._v("xx")]),e._v(" is more than "),t("code",[e._v("nullYear")]),e._v(", two-digit year values become "),t("code",[e._v("19xx")]),e._v(".")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 30")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"parsedatetime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsedatetime"}},[e._v("#")]),e._v(" parseDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("parseDateTime")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L249",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:249"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that parses strings representing date-time into actual date-time values.")]),e._v(" "),t("p",[e._v("The function should return a "),t("RouterLink",{attrs:{to:"/api/globals.html#datetime"}},[e._v("DateTime")]),e._v(" object or undefined.")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultParseToDateTime")]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("dateTimeString")]),e._v(": string, "),t("code",[e._v("dateFormat?")]),e._v(": undefined | string, "),t("code",[e._v("timeFormat?")]),e._v(": undefined | string): "),t("em",[e._v("Maybe‹DateTime›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("dateTimeString")])]),e._v(" "),t("td",[e._v("string")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("dateFormat?")])]),e._v(" "),t("td",[e._v("undefined | string")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("timeFormat?")])]),e._v(" "),t("td",[e._v("undefined | string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"stringifydatetime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifydatetime"}},[e._v("#")]),e._v(" stringifyDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDateTime")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L289",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:289"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that converts date-time values into strings.")]),e._v(" "),t("p",[e._v("The function should return a string or undefined.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultStringifyDateTime")]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("dateTime")]),e._v(": SimpleDateTime, "),t("code",[e._v("dateTimeFormat")]),e._v(": string): "),t("em",[e._v("Maybe‹string›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("dateTime")])]),e._v(" "),t("td",[e._v("SimpleDateTime")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("dateTimeFormat")])]),e._v(" "),t("td",[e._v("string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"stringifyduration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifyduration"}},[e._v("#")]),e._v(" stringifyDuration")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDuration")]),e._v(": "),t("em",[e._v("function")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L299",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:299"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a function that converts time duration values into strings.")]),e._v(" "),t("p",[e._v("The function should return a string or undefined.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" defaultStringifyDuration")]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[e._v("#")]),e._v(" Type declaration:")]),e._v(" "),t("p",[e._v("▸ ("),t("code",[e._v("time")]),e._v(": SimpleTime, "),t("code",[e._v("timeFormat")]),e._v(": string): "),t("em",[e._v("Maybe‹string›")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("time")])]),e._v(" "),t("td",[e._v("SimpleTime")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("timeFormat")])]),e._v(" "),t("td",[e._v("string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"timeformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#timeformats"}},[e._v("#")]),e._v(" timeFormats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("timeFormats")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L353",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:353"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the time formats accepted by the time-parsing function.")]),e._v(" "),t("p",[e._v("A format must be specified as a string consisting of at least two tokens separated by "),t("code",[e._v(":")]),e._v(" (a colon).")]),e._v(" "),t("p",[e._v("Supported tokens:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("hh")]),e._v(" (hours)")]),e._v(" "),t("li",[t("code",[e._v("mm")]),e._v(" (minutes)")]),e._v(" "),t("li",[t("code",[e._v("ss")]),e._v(", "),t("code",[e._v("ss.s")]),e._v(", "),t("code",[e._v("ss.ss")]),e._v(", "),t("code",[e._v("ss.sss")]),e._v(", "),t("code",[e._v("ss.ssss")]),e._v(", etc. (seconds)")])]),e._v(" "),t("p",[e._v("The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values.\nRegardless of the time format specified, the hours-minutes-seconds value may be followed by the AM/PM designator.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/date-and-time-handling.html"}},[e._v("Date and time handling guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("example")])]),e._v("\nE.g., for "),t("code",[e._v("timeFormats = ['hh:mm:ss.sss']")]),e._v(", valid time strings include:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("1:33:33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.3")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33.333")])]),e._v(" "),t("li",[t("code",[e._v("01:33:33")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 AM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 PM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 am")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33 pm")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33AM")])]),e._v(" "),t("li",[t("code",[e._v("1:33:33PM")])])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['hh:mm', 'hh:mm:ss.sss']")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"number"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#number"}},[e._v("#")]),e._v(" Number")]),e._v(" "),t("h3",{attrs:{id:"currencysymbol"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#currencysymbol"}},[e._v("#")]),e._v(" currencySymbol")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("currencySymbol")]),e._v(": "),t("em",[e._v("string[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:68"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets symbols that denote currency numbers.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ['$']")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"decimalseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decimalseparator"}},[e._v("#")]),e._v(" decimalSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("decimalSeparator")]),e._v(": "),t("em",[e._v('"." | ","')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:116"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets a decimal separator used for parsing numerical literals.")]),e._v(" "),t("p",[e._v("Can be one of the following:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v(".")]),e._v(" (period)")]),e._v(" "),t("li",[t("code",[e._v(",")]),e._v(" (comma)")])]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#thousandseparator"}},[e._v("thousandSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#functionargseparator"}},[e._v("functionArgSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" '.'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"precisionepsilon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionepsilon"}},[e._v("#")]),e._v(" precisionEpsilon")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("precisionEpsilon")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L264",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:264"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets how far two numerical values need to be from each other to be treated as non-equal.")]),e._v(" "),t("p",[t("code",[e._v("a")]),e._v(" and "),t("code",[e._v("b")]),e._v(" are equal if all three of the following conditions are met:")]),e._v(" "),t("ul",[t("li",[e._v("Both "),t("code",[e._v("a")]),e._v(" and "),t("code",[e._v("b")]),e._v(" are of the same sign")]),e._v(" "),t("li",[t("code",[e._v("abs(a)")]),e._v(" <= "),t("code",[e._v("(1+precisionEpsilon) * abs(b)")])]),e._v(" "),t("li",[t("code",[e._v("abs(b)")]),e._v(" <= "),t("code",[e._v("(1+precisionEpsilon) * abs(a)")])])]),e._v(" "),t("p",[e._v("Additionally, this option controls the snap-to-zero behavior for additions and subtractions:")]),e._v(" "),t("ul",[t("li",[e._v("For "),t("code",[e._v("c=a+b")]),e._v(", if "),t("code",[e._v("abs(c)")]),e._v(" <= "),t("code",[e._v("precisionEpsilon * abs(a)")]),e._v(", then "),t("code",[e._v("c")]),e._v(" is set to "),t("code",[e._v("0")])]),e._v(" "),t("li",[e._v("For "),t("code",[e._v("c=a-b")]),e._v(", if "),t("code",[e._v("abs(c)")]),e._v(" <= "),t("code",[e._v("precisionEpsilon * abs(a)")]),e._v(", then "),t("code",[e._v("c")]),e._v(" is set to "),t("code",[e._v("0")])])]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 1e-13")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"precisionrounding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionrounding"}},[e._v("#")]),e._v(" precisionRounding")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("precisionRounding")]),e._v(": "),t("em",[e._v("number")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L279",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:279"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the precision level of calculations' output.")]),e._v(" "),t("p",[e._v("Internally, all arithmetic operations are performed using JavaScript's built-in numbers.\nBut when HyperFormula exports a cell's value, it rounds the output\nto the "),t("code",[e._v("precisionRounding")]),e._v(" number of significant digits.")]),e._v(" "),t("p",[e._v("Setting "),t("code",[e._v("precisionRounding")]),e._v(" too low can cause large numbers' imprecision\n(for example, with "),t("code",[e._v("precisionRounding")]),e._v(" set to "),t("code",[e._v("4")]),e._v(", 100005 becomes 100010).")]),e._v(" "),t("p",[e._v("We recommend setting "),t("code",[e._v("precisionRounding")]),e._v(" to a value between "),t("code",[e._v("10")]),e._v(" and "),t("code",[e._v("14")]),e._v(".")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 14")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"smartrounding"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#smartrounding"}},[e._v("#")]),e._v(" smartRounding")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("smartRounding")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L307",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:307"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", no rounding happens, and numbers are equal if and only if they are of truly identical value.")]),e._v(" "),t("p",[e._v("For more information, see "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#precisionepsilon"}},[e._v("precisionEpsilon")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"thousandseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#thousandseparator"}},[e._v("#")]),e._v(" thousandSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("thousandSeparator")]),e._v(": "),t("em",[e._v('"" | "," | " " | "."')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L322",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:322"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the thousands' separator symbol for parsing numerical literals.")]),e._v(" "),t("p",[e._v("Can be one of the following:")]),e._v(" "),t("ul",[t("li",[e._v("empty")]),e._v(" "),t("li",[t("code",[e._v(",")]),e._v(" (comma)")]),e._v(" "),t("li",[t("code"),e._v(" (empty space)")])]),e._v(" "),t("p",[e._v("Must be different from "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#functionargseparator"}},[e._v("functionArgSeparator")]),e._v(".")],1),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" ''")]),e._v(" "),t("hr"),e._v(" "),t("h2",{attrs:{id:"string"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#string"}},[e._v("#")]),e._v(" String")]),e._v(" "),t("h3",{attrs:{id:"accentsensitive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accentsensitive"}},[e._v("#")]),e._v(" accentSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("accentSensitive")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", makes string comparison accent-sensitive.")]),e._v(" "),t("p",[e._v("Applies only to comparison operators.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"casefirst"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casefirst"}},[e._v("#")]),e._v(" caseFirst")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseFirst")]),e._v(": "),t("em",[e._v('"upper" | "lower" | "false"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:43"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("upper")]),e._v(", upper case sorts first.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("lower")]),e._v(", lower case sorts first.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", uses the locale's default.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'lower'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"casesensitive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casesensitive"}},[e._v("#")]),e._v(" caseSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseSensitive")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:33"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", makes string comparison case-sensitive.")]),e._v(" "),t("p",[e._v("Applies to comparison operators only.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"ignorepunctuation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorepunctuation"}},[e._v("#")]),e._v(" ignorePunctuation")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignorePunctuation")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:135"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", string comparison ignores punctuation.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"localelang"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#localelang"}},[e._v("#")]),e._v(" localeLang")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("localeLang")]),e._v(": "),t("em",[e._v("string")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L185",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:185"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Sets the locale for language-sensitive string comparison.")]),e._v(" "),t("p",[e._v("Accepts "),t("strong",[e._v("IETF BCP 47")]),e._v(" language tags.")]),e._v(" "),t("p",[e._v("For more information, see the "),t("RouterLink",{attrs:{to:"/guide/i18n-features.html"}},[e._v("Internationalization features guide")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" 'en'")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"matchwholecell"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#matchwholecell"}},[e._v("#")]),e._v(" matchWholeCell")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("matchWholeCell")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L193",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:193"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", function criteria require whole cells to match the pattern.")]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("false")]),e._v(", function criteria require just a sub-word to match the pattern.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"useregularexpressions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#useregularexpressions"}},[e._v("#")]),e._v(" useRegularExpressions")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useRegularExpressions")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L393",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:393"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" false")]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usewildcards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usewildcards"}},[e._v("#")]),e._v(" useWildcards")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useWildcards")]),e._v(": "),t("em",[e._v("boolean")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/ConfigParams.ts#L399",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/ConfigParams.ts:399"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("When set to "),t("code",[e._v("true")]),e._v(", criteria in functions (SUMIF, COUNTIF, ...) can use the "),t("code",[e._v("*")]),e._v(" and "),t("code",[e._v("?")]),e._v(" wildcards.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("default")])]),e._v(" true")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/32.51d25065.js b/assets/js/32.3fb72d16.js similarity index 98% rename from assets/js/32.51d25065.js rename to assets/js/32.3fb72d16.js index ab52d2194..95346699d 100644 --- a/assets/js/32.51d25065.js +++ b/assets/js/32.3fb72d16.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{324:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"listeners"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listeners"}},[t._v("#")]),t._v(" Listeners "),s("Badge",{attrs:{text:"Interface"}})],1),t._v(" "),s("h2",{attrs:{id:"batch"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch"}},[t._v("#")]),t._v(" Batch")]),t._v(" "),s("h3",{attrs:{id:"evaluationresumed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#evaluationresumed"}},[t._v("#")]),t._v(" evaluationResumed")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("evaluationResumed")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L316",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:316"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when evaluation is resumed.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'evaluationResumed' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationResumed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first, suspend evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// now, resume evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time evaluation is resumed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'evaluationResumed' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationResumed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation again")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume evaluation again")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"evaluationsuspended"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#evaluationsuspended"}},[t._v("#")]),t._v(" evaluationSuspended")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("evaluationSuspended")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L274",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:274"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when evaluation is suspended.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'evaluationSuspended' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationSuspended'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time evaluation is suspended")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'evaluationSuspended' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationSuspended'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation again")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ (): "),s("em",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"named-expression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#named-expression"}},[t._v("#")]),t._v(" Named Expression")]),t._v(" "),s("h3",{attrs:{id:"namedexpressionadded"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionadded"}},[t._v("#")]),t._v(" namedExpressionAdded")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("namedExpressionAdded")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L162",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:162"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a named expression with specified values and location is added.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of added expression")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("namedExpressionName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'namedExpressionAdded' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a named expression is added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'namedExpressionAdded' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add another named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("namedExpressionName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("namedExpressionName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"namedexpressionremoved"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionremoved"}},[t._v("#")]),t._v(" namedExpressionRemoved")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("namedExpressionRemoved")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L202",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:202"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a named expression with specified values is removed and from an indicated location.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of removed expression")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("namedExpressionName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'namedExpressionRemoved' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add some named expressions")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a named expression is removed")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'namedExpressionRemoved' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove another named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-4"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("namedExpressionName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("namedExpressionName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheet"}},[t._v("#")]),t._v(" Sheet")]),t._v(" "),s("h3",{attrs:{id:"sheetadded"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetadded"}},[t._v("#")]),t._v(" sheetAdded")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetAdded")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:52"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is added anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of added sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("addedSheetDisplayName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetAdded' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger the 'sheetAdded' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a sheet is added")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetAdded' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-5"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("addedSheetDisplayName")]),t._v(": string): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("addedSheetDisplayName")])]),t._v(" "),s("td",[t._v("string")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"sheetremoved"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetremoved"}},[t._v("#")]),t._v(" sheetRemoved")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetRemoved")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:89"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is removed from anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of removed sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("removedSheetDisplayName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetRemoved' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a sheet to trigger the 'sheetRemoved' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a sheet is removed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetRemoved' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-6"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("removedSheetDisplayName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("removedSheetDisplayName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"sheetrenamed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetrenamed"}},[t._v("#")]),t._v(" sheetRenamed")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetRenamed")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L126",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:126"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is renamed anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the old name of a sheet before renaming")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the new name of the sheet after renaming")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("oldName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Sheet ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("oldName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" was renamed to ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("newName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetRenamed' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRenamed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename a sheet to trigger the 'sheetRenamed' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints `Sheet ${oldName} was renamed to ${newName}` each time a sheet is renamed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetRenamed' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRenamed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-7"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("oldDisplayName")]),t._v(": string, "),s("code",[t._v("newDisplayName")]),t._v(": string): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("oldDisplayName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newDisplayName")])]),t._v(" "),s("td",[t._v("string")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"values"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#values"}},[t._v("#")]),t._v(" Values")]),t._v(" "),s("h3",{attrs:{id:"valuesupdated"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#valuesupdated"}},[t._v("#")]),t._v(" valuesUpdated")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("valuesUpdated")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L237",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:237"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when values in a specified location are changed and cause recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'valuesUpdated' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'valuesUpdated'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// trigger recalculation, for example, with the 'setCellContents' method")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a value change triggers recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'valuesUpdated' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'valuesUpdated'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// trigger another recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-8"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{324:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"listeners"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listeners"}},[t._v("#")]),t._v(" Listeners "),s("Badge",{attrs:{text:"Interface"}})],1),t._v(" "),s("h2",{attrs:{id:"batch"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch"}},[t._v("#")]),t._v(" Batch")]),t._v(" "),s("h3",{attrs:{id:"evaluationresumed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#evaluationresumed"}},[t._v("#")]),t._v(" evaluationResumed")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("evaluationResumed")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L316",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:316"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when evaluation is resumed.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'evaluationResumed' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationResumed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first, suspend evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// now, resume evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time evaluation is resumed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'evaluationResumed' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationResumed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation again")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume evaluation again")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"evaluationsuspended"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#evaluationsuspended"}},[t._v("#")]),t._v(" evaluationSuspended")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("evaluationSuspended")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L274",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:274"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when evaluation is suspended.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'evaluationSuspended' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationSuspended'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time evaluation is suspended")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resume evaluation")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("resumeEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'evaluationSuspended' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'evaluationSuspended'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// suspend evaluation again")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("suspendEvaluation")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ (): "),s("em",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"named-expression"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#named-expression"}},[t._v("#")]),t._v(" Named Expression")]),t._v(" "),s("h3",{attrs:{id:"namedexpressionadded"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionadded"}},[t._v("#")]),t._v(" namedExpressionAdded")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("namedExpressionAdded")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L162",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:162"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a named expression with specified values and location is added.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of added expression")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("namedExpressionName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'namedExpressionAdded' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a named expression is added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'namedExpressionAdded' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add another named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("namedExpressionName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("namedExpressionName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"namedexpressionremoved"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#namedexpressionremoved"}},[t._v("#")]),t._v(" namedExpressionRemoved")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("namedExpressionRemoved")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L202",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:202"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a named expression with specified values is removed and from an indicated location.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of removed expression")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'42'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("namedExpressionName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'namedExpressionRemoved' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add some named expressions")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=Sheet1!$A$1+100'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a named expression is removed")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'prettyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'namedExpressionRemoved' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'namedExpressionRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove another named expression")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeNamedExpression")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'uglyName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-4"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("namedExpressionName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("namedExpressionName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheet"}},[t._v("#")]),t._v(" Sheet")]),t._v(" "),s("h3",{attrs:{id:"sheetadded"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetadded"}},[t._v("#")]),t._v(" sheetAdded")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetAdded")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:52"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is added anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of added sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("addedSheetDisplayName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetAdded' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet to trigger the 'sheetAdded' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a sheet is added")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetAdded' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetAdded'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'FooBaz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-5"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("addedSheetDisplayName")]),t._v(": string): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("addedSheetDisplayName")])]),t._v(" "),s("td",[t._v("string")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"sheetremoved"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetremoved"}},[t._v("#")]),t._v(" sheetRemoved")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetRemoved")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:89"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is removed from anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the name of removed sheet")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("removedSheetDisplayName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetRemoved' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a sheet to trigger the 'sheetRemoved' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a sheet is removed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetRemoved' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRemoved'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// remove a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-6"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("removedSheetDisplayName")]),t._v(": string, "),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("removedSheetDisplayName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])]),t._v(" "),s("hr"),t._v(" "),s("h3",{attrs:{id:"sheetrenamed"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheetrenamed"}},[t._v("#")]),t._v(" sheetRenamed")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("sheetRenamed")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L126",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:126"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when a sheet is renamed anywhere inside the workbook.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the old name of a sheet before renaming")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the new name of the sheet after renaming")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(MySheet2!A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("MySheet2")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("oldName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newName")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Sheet ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("oldName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" was renamed to ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("newName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'sheetRenamed' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRenamed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename a sheet to trigger the 'sheetRenamed' event,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints `Sheet ${oldName} was renamed to ${newName}` each time a sheet is renamed")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet0'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'sheetRenamed' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sheetRenamed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MySheet1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-7"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("oldDisplayName")]),t._v(": string, "),s("code",[t._v("newDisplayName")]),t._v(": string): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("oldDisplayName")])]),t._v(" "),s("td",[t._v("string")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("newDisplayName")])]),t._v(" "),s("td",[t._v("string")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"values"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#values"}},[t._v("#")]),t._v(" Values")]),t._v(" "),s("h3",{attrs:{id:"valuesupdated"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#valuesupdated"}},[t._v("#")]),t._v(" valuesUpdated")]),t._v(" "),s("p",[t._v("• "),s("strong",[t._v("valuesUpdated")]),t._v(": "),s("em",[t._v("function")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L237",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:237"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Occurs when values in a specified location are changed and cause recalculation.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("param")])]),t._v(" the values and location of applied changes")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// define a function to be called when the event occurs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("handler")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("changes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'baz'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the 'valuesUpdated' event, pass the handler")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'valuesUpdated'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// trigger recalculation, for example, with the 'setCellContents' method")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the console prints 'baz' each time a value change triggers recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unsubscribe from the 'valuesUpdated' event")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("off")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'valuesUpdated'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" handler"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// trigger another recalculation")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this time, the console doesn't print anything")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h4",{attrs:{id:"type-declaration-8"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8"}},[t._v("#")]),t._v(" Type declaration:")]),t._v(" "),s("p",[t._v("▸ ("),s("code",[t._v("changes")]),t._v(": ExportedChange[]): "),s("em",[t._v("any")])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("changes")])]),t._v(" "),s("td",[t._v("ExportedChange[]")])])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/33.0b18acdc.js b/assets/js/33.d6c827f6.js similarity index 90% rename from assets/js/33.0b18acdc.js rename to assets/js/33.d6c827f6.js index 87cf4e06d..7d64a9231 100644 --- a/assets/js/33.0b18acdc.js +++ b/assets/js/33.d6c827f6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{325:function(t,e,v){"use strict";v.r(e);var r=v(14),_=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"typedemitter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#typedemitter"}},[t._v("#")]),t._v(" TypedEmitter "),e("Badge",{attrs:{text:"Interface"}})],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"off"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("off")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L322",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:322"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"on"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("on")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:320"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"once"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("once")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/0ebc875/src/Emitter.ts#L324",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:324"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])])])}),[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{326:function(t,e,v){"use strict";v.r(e);var r=v(14),_=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"typedemitter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#typedemitter"}},[t._v("#")]),t._v(" TypedEmitter "),e("Badge",{attrs:{text:"Interface"}})],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"off"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#off"}},[t._v("#")]),t._v(" off")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("off")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L322",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:322"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"on"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#on"}},[t._v("#")]),t._v(" on")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("on")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:320"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"once"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#once"}},[t._v("#")]),t._v(" once")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("once")]),t._v("‹"),e("strong",[t._v("Event")]),t._v("›("),e("code",[t._v("s")]),t._v(": Event, "),e("code",[t._v("listener")]),t._v(": Listeners[Event]): "),e("em",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/458a0e4/src/Emitter.ts#L324",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Emitter.ts:324"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Type parameters:")])]),t._v(" "),e("p",[t._v("▪ "),e("strong",[t._v("Event")]),t._v(": "),e("em",[t._v("keyof Listeners")])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("s")])]),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("listener")])]),t._v(" "),e("td",[t._v("Listeners[Event]")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("em",[t._v("void")])])])}),[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/assets/js/34.61ab12b3.js b/assets/js/34.e78b98bf.js similarity index 96% rename from assets/js/34.61ab12b3.js rename to assets/js/34.e78b98bf.js index 27c748f11..275a6c196 100644 --- a/assets/js/34.61ab12b3.js +++ b/assets/js/34.e78b98bf.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{327:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"advanced-usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#advanced-usage"}},[t._v("#")]),t._v(" Advanced usage")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("By default, cells are identified using a "),s("code",[t._v("SimpleCellAddress")]),t._v(" which\nconsists of a sheet ID, column ID, and row ID, like\nthis: "),s("code",[t._v("{ sheet: 0, col: 0, row: 0 }")])]),t._v(" "),s("p",[t._v("Alternatively, you can work with the "),s("strong",[t._v("A1 notation")]),t._v(" known from\nspreadsheets like Excel or Google Sheets. The API provides the helper\nfunction "),s("code",[t._v("simpleCellAddressFromString")]),t._v(" which you can use to\nretrieve the "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")])]),t._v(" "),s("p",[t._v("The following example shows how to use formulas to find out which of\nthe two Teams (A or B) is the winning one. You will do that by\ncomparing the average scores of players in each team.")]),t._v(" "),s("p",[t._v("The initial steps are the same as in the\n"),s("RouterLink",{attrs:{to:"/guide/basic-usage.html"}},[t._v("basic example")]),t._v(". First, import HyperFormula and choose\nthe configuration options:")],1),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" HyperFormula "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hyperformula'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" options "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("licenseKey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gpl-v3'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This time you will use the "),s("code",[t._v("buildFromEmpty")]),t._v(" static method to\ninitialize the engine:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initiate the engine with no data")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now, let's prepare some data. The first column will be players'\nIDs and the second column will be their scores. Then, you will\ndefine the formulas responsible for calculating the average scores.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first column represents players' IDs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// second column represents players' scores")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" playersA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'13'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'17'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" playersB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'19'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'31'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'9'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'61'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'89'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'11'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'107'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'127'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cell A1 a formula checks which team is the winning one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cells A2 and A3 formulas calculate the average score of players")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" formulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('\'=IF(Formulas!A2>Formulas!A3,"TeamA","TeamB")\'')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=AVERAGE(TeamA!B1:B6)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=AVERAGE(TeamB!B1:B6)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now prepare sheets and insert the data into them:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add 'TeamA' sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'TeamA'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert playersA content into targeted 'TeamA' sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" playersA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add 'TeamB' sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'TeamB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert playersB content into targeted 'TeamB' sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" playersB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check the content in the console output")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("After setting everything up, you can add formulas:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet named 'Formulas'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameC "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Formulas'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdC "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add formulas to that sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" formulas"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Almost done! Now, you can use the "),s("code",[t._v("getSheetValues")]),t._v(" method to get all\nvalues including the calculated ones. Alternatively, you can use\n"),s("code",[t._v("getCellValue")]),t._v("to get the value from a specific cell.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get all sheet values ")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the simple cell address of 'A1' from that sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check the winning team 🎉")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" winningTeam "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("simpleCellAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// print the result to the console")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("winningTeam"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"demo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),s("iframe",{staticStyle:{width:"100%",height:"1070px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.7.x/advanced-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview&v="+t.$page.buildDateURIEncoded,title:"handsontable/hyperformula-demos: advanced-usage",allow:"accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking",sandbox:"allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"}})])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{327:function(t,s,a){"use strict";a.r(s);var n=a(14),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"advanced-usage"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#advanced-usage"}},[t._v("#")]),t._v(" Advanced usage")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("By default, cells are identified using a "),s("code",[t._v("SimpleCellAddress")]),t._v(" which\nconsists of a sheet ID, column ID, and row ID, like\nthis: "),s("code",[t._v("{ sheet: 0, col: 0, row: 0 }")])]),t._v(" "),s("p",[t._v("Alternatively, you can work with the "),s("strong",[t._v("A1 notation")]),t._v(" known from\nspreadsheets like Excel or Google Sheets. The API provides the helper\nfunction "),s("code",[t._v("simpleCellAddressFromString")]),t._v(" which you can use to\nretrieve the "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")])]),t._v(" "),s("p",[t._v("The following example shows how to use formulas to find out which of\nthe two Teams (A or B) is the winning one. You will do that by\ncomparing the average scores of players in each team.")]),t._v(" "),s("p",[t._v("The initial steps are the same as in the\n"),s("RouterLink",{attrs:{to:"/guide/basic-usage.html"}},[t._v("basic example")]),t._v(". First, import HyperFormula and choose\nthe configuration options:")],1),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" HyperFormula "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hyperformula'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" options "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("licenseKey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gpl-v3'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This time you will use the "),s("code",[t._v("buildFromEmpty")]),t._v(" static method to\ninitialize the engine:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initiate the engine with no data")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildEmpty")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now, let's prepare some data. The first column will be players'\nIDs and the second column will be their scores. Then, you will\ndefine the formulas responsible for calculating the average scores.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// first column represents players' IDs")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// second column represents players' scores")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" playersA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'3'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'13'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'17'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" playersB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'7'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'19'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'31'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'9'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'61'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'10'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'89'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'11'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'107'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'12'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'127'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cell A1 a formula checks which team is the winning one")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// in cells A2 and A3 formulas calculate the average score of players")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" formulas "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('\'=IF(Formulas!A2>Formulas!A3,"TeamA","TeamB")\'')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=AVERAGE(TeamA!B1:B6)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=AVERAGE(TeamB!B1:B6)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now prepare sheets and insert the data into them:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add 'TeamA' sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'TeamA'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdA "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert playersA content into targeted 'TeamA' sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" playersA"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add 'TeamB' sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'TeamB'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdB "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert playersB content into targeted 'TeamB' sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" playersB"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check the content in the console output")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getAllSheetsValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("After setting everything up, you can add formulas:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add a sheet named 'Formulas'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetNameC "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Formulas'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the new sheet ID for further API calls")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetIdC "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetNameC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// add formulas to that sheet")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" formulas"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Almost done! Now, you can use the "),s("code",[t._v("getSheetValues")]),t._v(" method to get all\nvalues including the calculated ones. Alternatively, you can use\n"),s("code",[t._v("getCellValue")]),t._v("to get the value from a specific cell.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get all sheet values ")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetValues "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetValues")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the simple cell address of 'A1' from that sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" simpleCellAddress "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("simpleCellAddressFromString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" sheetIdC"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check the winning team 🎉")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" winningTeam "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("simpleCellAddress"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// print the result to the console")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("winningTeam"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"demo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),s("iframe",{staticStyle:{width:"100%",height:"590px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://stackblitz.com/github/handsontable/hyperformula-demos/tree/2.7.x/advanced-usage?embed=1&file=src/hyperformulaConfig.js&hideNavigation=1&view=preview&v="+t.$page.buildDateURIEncoded}})])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/36.56a7ae41.js b/assets/js/36.d2174e4f.js similarity index 98% rename from assets/js/36.56a7ae41.js rename to assets/js/36.d2174e4f.js index 41316e572..6d3f3d992 100644 --- a/assets/js/36.56a7ae41.js +++ b/assets/js/36.d2174e4f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{338:function(t,s,a){"use strict";a.r(s);var e=a(14),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"basic-operations"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#basic-operations"}},[t._v("#")]),t._v(" Basic operations")]),t._v(" "),s("p",[t._v("HyperFormula can perform efficient "),s("strong",[t._v("CRUD")]),t._v(" operations on the workbook.\nYou can apply these operations to various workbook elements, such as:")]),t._v(" "),s("ul",[s("li",[t._v("Cells")]),t._v(" "),s("li",[t._v("Rows / Columns")]),t._v(" "),s("li",[t._v("Sheets")])]),t._v(" "),s("p",[s("strong",[t._v("Check the "),s("a",{attrs:{href:"../api"}},[t._v("API")])]),t._v(" for a full reference of methods available for CRUD\noperations.")]),t._v(" "),s("p",[t._v("HyperFormula automatically updates all references, both relative and\nabsolute, in all sheets affected by the change.")]),t._v(" "),s("p",[t._v("Operations affecting only the dependency graph should not decrease\nperformance. However, multiple operations that have an impact on\ncalculation results may affect performance; these are "),s("code",[t._v("clearSheet")]),t._v(",\n"),s("code",[t._v("setSheetContent")]),t._v(", "),s("code",[t._v("setCellContents")]),t._v(", "),s("code",[t._v("addNamedExpression")]),t._v(",\n"),s("code",[t._v("changeNamedExpression")]),t._v(", and "),s("code",[t._v("removeNamedExpression")]),t._v(". It is advised\nto "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch")]),t._v(" them.")],1),t._v(" "),s("h2",{attrs:{id:"sheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheets"}},[t._v("#")]),t._v(" Sheets")]),t._v(" "),s("h3",{attrs:{id:"adding-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-a-sheet"}},[t._v("#")]),t._v(" Adding a sheet")]),t._v(" "),s("p",[t._v("A sheet can be added by using the "),s("code",[t._v("addSheet")]),t._v(" method. You can pass a\nname for it or leave it without a parameter. In the latter case the\nmethod will create an autogenerated name for it. That name can then\nbe returned for further use.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the autogenerated sheet name can be assigned to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myNewSheet "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create a sheet with a specific name")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'SheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("You can also count sheets by using the "),s("code",[t._v("countSheets")]),t._v(" method. This\nmethod does not require any parameters.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// count the number of sheets you added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetsCount "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("countSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-a-sheet"}},[t._v("#")]),t._v(" Removing a sheet")]),t._v(" "),s("p",[t._v("A sheet can be removed by using the "),s("code",[t._v("removeSheet")]),t._v(" method. To do that\nyou need to pass a mandatory parameter: the ID of a sheet to be\nremoved.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing the sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"renaming-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#renaming-a-sheet"}},[t._v("#")]),t._v(" Renaming a sheet")]),t._v(" "),s("p",[t._v("A sheet can be renamed by using the "),s("code",[t._v("renameSheet")]),t._v(" method. You need to\npass the ID of a sheet you want to rename (you can get it with the\n"),s("code",[t._v("getSheetId")]),t._v(" method only if you know its name) along with a new name\nas the first and second parameters, respectively.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename the first sheet ")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'NewSheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you can retrieve the sheet ID if you know its name")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetID "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'SheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use the retrieved sheet ID in the method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetID"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'AnotherNewName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"clearing-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearing-a-sheet"}},[t._v("#")]),t._v(" Clearing a sheet")]),t._v(" "),s("p",[t._v("A sheet's content can be cleared with the "),s("code",[t._v("clearSheet")]),t._v(" method. You need\nto provide the ID of a sheet whose content you want to clear.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the content of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"replacing-sheet-content"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#replacing-sheet-content"}},[t._v("#")]),t._v(" Replacing sheet content")]),t._v(" "),s("p",[t._v("Instead of removing and adding the content of a sheet you can replace\nit right away. To do so use "),s("code",[t._v("setSheetContent")]),t._v(", in which you can pass\nthe sheet ID and its new values.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// set new values for sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rows"}},[t._v("#")]),t._v(" Rows")]),t._v(" "),s("h3",{attrs:{id:"adding-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-rows"}},[t._v("#")]),t._v(" Adding rows")]),t._v(" "),s("p",[t._v("You can add one or more rows by using the "),s("code",[t._v("addRows")]),t._v(" method. The first\nparameter you need to pass is a sheet ID, and the second parameter\nrepresents the position and the size of a block of rows to be added.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by adding")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two rows at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-rows"}},[t._v("#")]),t._v(" Removing rows")]),t._v(" "),s("p",[t._v("You can remove one or more rows by using the "),s("code",[t._v("removeRows")]),t._v(" method. The\nfirst parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of rows to\nbe removed.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two rows at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"moving-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-rows"}},[t._v("#")]),t._v(" Moving rows")]),t._v(" "),s("p",[t._v("You can move one or more rows by using the "),s("code",[t._v("moveRows")]),t._v(" method. You need\nto pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("Starting row")]),t._v(" "),s("li",[t._v("Number of rows to be moved")]),t._v(" "),s("li",[t._v("Target row")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the first row in the first sheet into row 2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"reordering-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reordering-rows"}},[t._v("#")]),t._v(" Reordering rows")]),t._v(" "),s("p",[t._v("You can change the order of rows by using the "),s("code",[t._v("setRowOrder")]),t._v(" method. You need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("New row order")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// row 0 and row 2 swap places")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#columns"}},[t._v("#")]),t._v(" Columns")]),t._v(" "),s("h3",{attrs:{id:"adding-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-columns"}},[t._v("#")]),t._v(" Adding columns")]),t._v(" "),s("p",[t._v("You can add one or more columns by using the "),s("code",[t._v("addColumns")]),t._v(" method.\nThe first parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of columns\nto be added.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by adding")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two columns at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-columns"}},[t._v("#")]),t._v(" Removing columns")]),t._v(" "),s("p",[t._v("You can remove one or more columns by using the "),s("code",[t._v("removeColumns")]),t._v(" method.\nThe first parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of columns\nto be removed.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two columns at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"moving-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-columns"}},[t._v("#")]),t._v(" Moving columns")]),t._v(" "),s("p",[t._v("You can move one or more columns by using the "),s("code",[t._v("moveColumns")]),t._v(" method.\nYou need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("Starting column")]),t._v(" "),s("li",[t._v("Number of columns to be moved")]),t._v(" "),s("li",[t._v("Target column")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the first column in the first sheet into column 2 ")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"reordering-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reordering-columns"}},[t._v("#")]),t._v(" Reordering columns")]),t._v(" "),s("p",[t._v("You can change the order of columns by using the "),s("code",[t._v("setColumnOrder")]),t._v(" method. You need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("New column order")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// column 0 and column 2 swap places")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cells"}},[t._v("#")]),t._v(" Cells")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("By default, cells are identified using a "),s("code",[t._v("SimpleCellAddress")]),t._v(" which\nconsists of a sheet ID, column ID, and row ID, like this:\n"),s("code",[t._v("{ sheet: 0, col: 0, row: 0 }")])]),t._v(" "),s("p",[t._v("Alternatively, you can work with the "),s("strong",[t._v("A1 notation")]),t._v(" known from\nspreadsheets like Excel or Google Sheets. The API provides the helper\nfunction "),s("code",[t._v("simpleCellAddressFromString")]),t._v(" which you can use to retrieve\nthe "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")])]),t._v(" "),s("h3",{attrs:{id:"moving-cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-cells"}},[t._v("#")]),t._v(" Moving cells")]),t._v(" "),s("p",[t._v("You can move one or more cells using the "),s("code",[t._v("moveCells")]),t._v(" method. You need\nto pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Source range ("),s("a",{attrs:{href:"../api/interfaces/simplecellrange"}},[t._v("SimpleCellRange")]),t._v(")")]),t._v(" "),s("li",[t._v("Top left corner of the destination range ("),s("a",{attrs:{href:"../api/interfaces/simplecelladdress"}},[t._v("SimpleCellAddress")]),t._v(")")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the source cells")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the target cells")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one cell from source to target location")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"updating-cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#updating-cells"}},[t._v("#")]),t._v(" Updating cells")]),t._v(" "),s("p",[t._v("You can set the content of a block of cells by using the\n"),s("code",[t._v("setCellContents")]),t._v(" method. You need to pass the top left corner address\nof a block as a simple cell address, along with the content to be set.\nIt can be content for either a single cell or a set of cells in an array.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by setting")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a block of cells with content '=B1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"getting-cell-value"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-cell-value"}},[t._v("#")]),t._v(" Getting cell value")]),t._v(" "),s("p",[t._v("You can get the value of a cell by using "),s("code",[t._v("getCellValue")]),t._v(" . Remember to\npass the coordinates as a "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the value of the B1 cell")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"getting-cell-formula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-cell-formula"}},[t._v("#")]),t._v(" Getting cell formula")]),t._v(" "),s("p",[t._v("You can retrieve the formula from a cell by using "),s("code",[t._v("getCellFormula")]),t._v(".\nRemember to pass the coordinates as a "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the formula from the A1 cell")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"handling-an-error"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#handling-an-error"}},[t._v("#")]),t._v(" Handling an error")]),t._v(" "),s("p",[t._v("Each time you call a method, HyperFormula will perform the corresponding\noperation. If there is an issue, it will throw an error. Methods\navailable in the HyperFormula's API might throw different errors,\nbut all of them follow the same pattern. Thus, the errors can be\nhandled in a similar manner.")]),t._v(" "),s("p",[t._v("For example, imagine you let users rename their sheets in an\napplication but by mistake they choose a sheet ID that does not exist.\nIt would be nice to display the error to the user, so they are aware\nof this fact.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// variable used to carry the message for the user")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" messageUsedInUI"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// attempt to rename a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Payroll"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// whoops! there is no sheet with an ID of 5")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// notify the user that a sheet with an ID of 5 does not exist")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("instanceof")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("NoSheetWithIdError")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sheet with provided ID does not exist"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a generic error message, just in case")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Something went wrong"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"isitpossibleto-methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibleto-methods"}},[t._v("#")]),t._v(" isItPossibleTo* methods")]),t._v(" "),s("p",[t._v("There are also methods that you may find useful to call in pair with\nthe above-mentioned operations. These methods are prefixed with\n"),s("code",[t._v("isItPossibleTo*")]),t._v(" whose sole purpose is to check if the desired\noperation is possible. They all return a simple "),s("code",[t._v("boolean")]),t._v(" value.\nYou will find it handy when you want to give the user a more generic\nmessage and you don't want to react to specific errors.")]),t._v(" "),s("p",[t._v("This can be particularly useful for interaction with the UI of the\napplication you work on. For example, you can allow the user to add\nnew sheets by typing a new sheet name inside an input field. You can\neasily check if that action is allowed, and if it is not, throw an error.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// an instance with some example data")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a variable used to carry the message for the user")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" messageUsedInUI"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use this method to check the possibility to remove columns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check if there is a possibility to remove columns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("isRemovable"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sorry, you cannot perform a remove action'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"changes-array"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#changes-array"}},[t._v("#")]),t._v(" Changes array")]),t._v(" "),s("p",[t._v("All data modification methods return an array of "),s("code",[t._v("ExportedChange")]),t._v(".\nThis is a collection of cells whose "),s("strong",[t._v("values")]),t._v(" were affected by an operation,\ntogether with their absolute addresses and new values.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("address")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("newValue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("CellError"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#REF!'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),s("p",[t._v("This gives you information about where the change happened, what the\nnew value of a cell is, and even what type it is - in this case, an\nerror.")]),t._v(" "),s("p",[t._v("The array of changes includes only cells that have different "),s("strong",[t._v("values")]),t._v(" after performing the operation. See the example:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hf "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=COUNTBLANK(A1:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert an empty row between the row 0 and the row 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("hf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sheet after adding the row:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [1],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['=SUM(A1:A3)'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['=COUNTBLANK(A1:A4)'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ]")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("changes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// changes include only the COUNTBLANK cell:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, row: 4, col: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n")])])]),s("h2",{attrs:{id:"demo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),s("p",[t._v("This demo presents several basic operations integrated with a\nsample UI.")]),t._v(" "),s("iframe",{staticStyle:{width:"100%",height:"1070px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.7.x/basic-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview&v="+t.$page.buildDateURIEncoded,title:"handsontable/hyperformula-demos: basic-operations",allow:"accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking",sandbox:"allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"}})])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{329:function(t,s,a){"use strict";a.r(s);var e=a(14),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"basic-operations"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#basic-operations"}},[t._v("#")]),t._v(" Basic operations")]),t._v(" "),s("p",[t._v("HyperFormula can perform efficient "),s("strong",[t._v("CRUD")]),t._v(" operations on the workbook.\nYou can apply these operations to various workbook elements, such as:")]),t._v(" "),s("ul",[s("li",[t._v("Cells")]),t._v(" "),s("li",[t._v("Rows / Columns")]),t._v(" "),s("li",[t._v("Sheets")])]),t._v(" "),s("p",[s("strong",[t._v("Check the "),s("a",{attrs:{href:"../api"}},[t._v("API")])]),t._v(" for a full reference of methods available for CRUD\noperations.")]),t._v(" "),s("p",[t._v("HyperFormula automatically updates all references, both relative and\nabsolute, in all sheets affected by the change.")]),t._v(" "),s("p",[t._v("Operations affecting only the dependency graph should not decrease\nperformance. However, multiple operations that have an impact on\ncalculation results may affect performance; these are "),s("code",[t._v("clearSheet")]),t._v(",\n"),s("code",[t._v("setSheetContent")]),t._v(", "),s("code",[t._v("setCellContents")]),t._v(", "),s("code",[t._v("addNamedExpression")]),t._v(",\n"),s("code",[t._v("changeNamedExpression")]),t._v(", and "),s("code",[t._v("removeNamedExpression")]),t._v(". It is advised\nto "),s("RouterLink",{attrs:{to:"/guide/batch-operations.html"}},[t._v("batch")]),t._v(" them.")],1),t._v(" "),s("h2",{attrs:{id:"sheets"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sheets"}},[t._v("#")]),t._v(" Sheets")]),t._v(" "),s("h3",{attrs:{id:"adding-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-a-sheet"}},[t._v("#")]),t._v(" Adding a sheet")]),t._v(" "),s("p",[t._v("A sheet can be added by using the "),s("code",[t._v("addSheet")]),t._v(" method. You can pass a\nname for it or leave it without a parameter. In the latter case the\nmethod will create an autogenerated name for it. That name can then\nbe returned for further use.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the autogenerated sheet name can be assigned to a variable")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myNewSheet "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create a sheet with a specific name")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'SheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("You can also count sheets by using the "),s("code",[t._v("countSheets")]),t._v(" method. This\nmethod does not require any parameters.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// count the number of sheets you added")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetsCount "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("countSheets")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-a-sheet"}},[t._v("#")]),t._v(" Removing a sheet")]),t._v(" "),s("p",[t._v("A sheet can be removed by using the "),s("code",[t._v("removeSheet")]),t._v(" method. To do that\nyou need to pass a mandatory parameter: the ID of a sheet to be\nremoved.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing the sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"renaming-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#renaming-a-sheet"}},[t._v("#")]),t._v(" Renaming a sheet")]),t._v(" "),s("p",[t._v("A sheet can be renamed by using the "),s("code",[t._v("renameSheet")]),t._v(" method. You need to\npass the ID of a sheet you want to rename (you can get it with the\n"),s("code",[t._v("getSheetId")]),t._v(" method only if you know its name) along with a new name\nas the first and second parameters, respectively.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// rename the first sheet ")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'NewSheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you can retrieve the sheet ID if you know its name")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sheetID "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetId")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'SheetName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use the retrieved sheet ID in the method")]),t._v("\nhfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sheetID"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'AnotherNewName'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"clearing-a-sheet"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#clearing-a-sheet"}},[t._v("#")]),t._v(" Clearing a sheet")]),t._v(" "),s("p",[t._v("A sheet's content can be cleared with the "),s("code",[t._v("clearSheet")]),t._v(" method. You need\nto provide the ID of a sheet whose content you want to clear.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// clear the content of sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clearSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"replacing-sheet-content"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#replacing-sheet-content"}},[t._v("#")]),t._v(" Replacing sheet content")]),t._v(" "),s("p",[t._v("Instead of removing and adding the content of a sheet you can replace\nit right away. To do so use "),s("code",[t._v("setSheetContent")]),t._v(", in which you can pass\nthe sheet ID and its new values.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// set new values for sheet 0")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setSheetContent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'50'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'60'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rows"}},[t._v("#")]),t._v(" Rows")]),t._v(" "),s("h3",{attrs:{id:"adding-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-rows"}},[t._v("#")]),t._v(" Adding rows")]),t._v(" "),s("p",[t._v("You can add one or more rows by using the "),s("code",[t._v("addRows")]),t._v(" method. The first\nparameter you need to pass is a sheet ID, and the second parameter\nrepresents the position and the size of a block of rows to be added.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by adding")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two rows at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-rows"}},[t._v("#")]),t._v(" Removing rows")]),t._v(" "),s("p",[t._v("You can remove one or more rows by using the "),s("code",[t._v("removeRows")]),t._v(" method. The\nfirst parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of rows to\nbe removed.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two rows at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"moving-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-rows"}},[t._v("#")]),t._v(" Moving rows")]),t._v(" "),s("p",[t._v("You can move one or more rows by using the "),s("code",[t._v("moveRows")]),t._v(" method. You need\nto pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("Starting row")]),t._v(" "),s("li",[t._v("Number of rows to be moved")]),t._v(" "),s("li",[t._v("Target row")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the first row in the first sheet into row 2")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"reordering-rows"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reordering-rows"}},[t._v("#")]),t._v(" Reordering rows")]),t._v(" "),s("p",[t._v("You can change the order of rows by using the "),s("code",[t._v("setRowOrder")]),t._v(" method. You need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("New row order")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// row 0 and row 2 swap places")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setRowOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#columns"}},[t._v("#")]),t._v(" Columns")]),t._v(" "),s("h3",{attrs:{id:"adding-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#adding-columns"}},[t._v("#")]),t._v(" Adding columns")]),t._v(" "),s("p",[t._v("You can add one or more columns by using the "),s("code",[t._v("addColumns")]),t._v(" method.\nThe first parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of columns\nto be added.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by adding")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two columns at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"removing-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-columns"}},[t._v("#")]),t._v(" Removing columns")]),t._v(" "),s("p",[t._v("You can remove one or more columns by using the "),s("code",[t._v("removeColumns")]),t._v(" method.\nThe first parameter you need to pass is a sheet ID, and the second\nparameter represents the position and the size of a block of columns\nto be removed.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by removing")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// two columns at position 0 inside the first sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"moving-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-columns"}},[t._v("#")]),t._v(" Moving columns")]),t._v(" "),s("p",[t._v("You can move one or more columns by using the "),s("code",[t._v("moveColumns")]),t._v(" method.\nYou need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("Starting column")]),t._v(" "),s("li",[t._v("Number of columns to be moved")]),t._v(" "),s("li",[t._v("Target column")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the first column in the first sheet into column 2 ")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"reordering-columns"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#reordering-columns"}},[t._v("#")]),t._v(" Reordering columns")]),t._v(" "),s("p",[t._v("You can change the order of columns by using the "),s("code",[t._v("setColumnOrder")]),t._v(" method. You need to pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Sheet ID")]),t._v(" "),s("li",[t._v("New column order")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// column 0 and column 2 swap places")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setColumnOrder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#cells"}},[t._v("#")]),t._v(" Cells")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("By default, cells are identified using a "),s("code",[t._v("SimpleCellAddress")]),t._v(" which\nconsists of a sheet ID, column ID, and row ID, like this:\n"),s("code",[t._v("{ sheet: 0, col: 0, row: 0 }")])]),t._v(" "),s("p",[t._v("Alternatively, you can work with the "),s("strong",[t._v("A1 notation")]),t._v(" known from\nspreadsheets like Excel or Google Sheets. The API provides the helper\nfunction "),s("code",[t._v("simpleCellAddressFromString")]),t._v(" which you can use to retrieve\nthe "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")])]),t._v(" "),s("h3",{attrs:{id:"moving-cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#moving-cells"}},[t._v("#")]),t._v(" Moving cells")]),t._v(" "),s("p",[t._v("You can move one or more cells using the "),s("code",[t._v("moveCells")]),t._v(" method. You need\nto pass the following parameters:")]),t._v(" "),s("ul",[s("li",[t._v("Source range ("),s("a",{attrs:{href:"../api/interfaces/simplecellrange"}},[t._v("SimpleCellRange")]),t._v(")")]),t._v(" "),s("li",[t._v("Top left corner of the destination range ("),s("a",{attrs:{href:"../api/interfaces/simplecelladdress"}},[t._v("SimpleCellAddress")]),t._v(")")])]),t._v(" "),s("p",[t._v("This method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the source cells")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// choose the target cells")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" destination "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by moving")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// one cell from source to target location")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("moveCells")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("start")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("end")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" source "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" destination"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"updating-cells"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#updating-cells"}},[t._v("#")]),t._v(" Updating cells")]),t._v(" "),s("p",[t._v("You can set the content of a block of cells by using the\n"),s("code",[t._v("setCellContents")]),t._v(" method. You need to pass the top left corner address\nof a block as a simple cell address, along with the content to be set.\nIt can be content for either a single cell or a set of cells in an array.\nThis method returns "),s("a",{attrs:{href:"#changes-array"}},[t._v("an array of changed cells")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// track the changes triggered by setting")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a block of cells with content '=B1'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCellContents")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=B1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"getting-cell-value"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-cell-value"}},[t._v("#")]),t._v(" Getting cell value")]),t._v(" "),s("p",[t._v("You can get the value of a cell by using "),s("code",[t._v("getCellValue")]),t._v(" . Remember to\npass the coordinates as a "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the value of the B1 cell")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" B1Value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"getting-cell-formula"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-cell-formula"}},[t._v("#")]),t._v(" Getting cell formula")]),t._v(" "),s("p",[t._v("You can retrieve the formula from a cell by using "),s("code",[t._v("getCellFormula")]),t._v(".\nRemember to pass the coordinates as a "),s("code",[t._v("SimpleCellAddress")]),t._v(" .")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the formula from the A1 cell")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" A1Formula "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getCellFormula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"handling-an-error"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#handling-an-error"}},[t._v("#")]),t._v(" Handling an error")]),t._v(" "),s("p",[t._v("Each time you call a method, HyperFormula will perform the corresponding\noperation. If there is an issue, it will throw an error. Methods\navailable in the HyperFormula's API might throw different errors,\nbut all of them follow the same pattern. Thus, the errors can be\nhandled in a similar manner.")]),t._v(" "),s("p",[t._v("For example, imagine you let users rename their sheets in an\napplication but by mistake they choose a sheet ID that does not exist.\nIt would be nice to display the error to the user, so they are aware\nof this fact.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// variable used to carry the message for the user")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" messageUsedInUI"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// attempt to rename a sheet")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("renameSheet")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Payroll"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// whoops! there is no sheet with an ID of 5")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// notify the user that a sheet with an ID of 5 does not exist")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("instanceof")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("NoSheetWithIdError")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sheet with provided ID does not exist"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a generic error message, just in case")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Something went wrong"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"isitpossibleto-methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isitpossibleto-methods"}},[t._v("#")]),t._v(" isItPossibleTo* methods")]),t._v(" "),s("p",[t._v("There are also methods that you may find useful to call in pair with\nthe above-mentioned operations. These methods are prefixed with\n"),s("code",[t._v("isItPossibleTo*")]),t._v(" whose sole purpose is to check if the desired\noperation is possible. They all return a simple "),s("code",[t._v("boolean")]),t._v(" value.\nYou will find it handy when you want to give the user a more generic\nmessage and you don't want to react to specific errors.")]),t._v(" "),s("p",[t._v("This can be particularly useful for interaction with the UI of the\napplication you work on. For example, you can allow the user to add\nnew sheets by typing a new sheet name inside an input field. You can\neasily check if that action is allowed, and if it is not, throw an error.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// an instance with some example data")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'1'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// a variable used to carry the message for the user")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" messageUsedInUI"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// use this method to check the possibility to remove columns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" isRemovable "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hfInstance"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isItPossibleToRemoveColumns")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// check if there is a possibility to remove columns")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("isRemovable"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n messageUsedInUI "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sorry, you cannot perform a remove action'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"changes-array"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#changes-array"}},[t._v("#")]),t._v(" Changes array")]),t._v(" "),s("p",[t._v("All data modification methods return an array of "),s("code",[t._v("ExportedChange")]),t._v(".\nThis is a collection of cells whose "),s("strong",[t._v("values")]),t._v(" were affected by an operation,\ntogether with their absolute addresses and new values.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("address")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("sheet")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("col")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("row")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("newValue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("CellError"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#REF!'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),s("p",[t._v("This gives you information about where the change happened, what the\nnew value of a cell is, and even what type it is - in this case, an\nerror.")]),t._v(" "),s("p",[t._v("The array of changes includes only cells that have different "),s("strong",[t._v("values")]),t._v(" after performing the operation. See the example:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hf "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" HyperFormula"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildFromArray")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=SUM(A1:A2)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'=COUNTBLANK(A1:A3)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// insert an empty row between the row 0 and the row 1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" changes "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" hf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("addRows")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("hf"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSheetSerialized")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sheet after adding the row:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [0],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [1],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['=SUM(A1:A3)'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ['=COUNTBLANK(A1:A4)'],")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ]")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("changes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// changes include only the COUNTBLANK cell:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// [{")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// address: { sheet: 0, row: 4, col: 0 },")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// newValue: 1,")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// }]")]),t._v("\n")])])]),s("h2",{attrs:{id:"demo"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),s("p",[t._v("This demo presents several basic operations integrated with a\nsample UI.")]),t._v(" "),s("iframe",{staticStyle:{width:"100%",height:"590px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://stackblitz.com/github/handsontable/hyperformula-demos/tree/2.7.x/basic-operations?embed=1&file=src/hyperformulaConfig.js&hideNavigation=1&view=preview&v="+t.$page.buildDateURIEncoded}})])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/37.d14d492b.js b/assets/js/37.a71973b7.js similarity index 91% rename from assets/js/37.d14d492b.js rename to assets/js/37.a71973b7.js index 24c12d0ad..3cbf31fb8 100644 --- a/assets/js/37.d14d492b.js +++ b/assets/js/37.a71973b7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{329:function(t,a,s){"use strict";s.r(a);var e=s(14),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"basic-usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#basic-usage"}},[t._v("#")]),t._v(" Basic usage")]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("The instance can be created with three static methods:\n"),a("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#buildfromarray"}},[a("code",[t._v("buildFromArray")])]),t._v(",\n"),a("code",[t._v("buildFromSheets")]),t._v(" or "),a("code",[t._v("buildEmpty")]),t._v(". You can check all of their\ndescriptions in our "),a("a",{attrs:{href:"../api"}},[t._v("API reference")]),t._v(".")],1)]),t._v(" "),a("p",[t._v("If you've already installed the library, it's time to start writing the\nfirst simple application.")]),t._v(" "),a("p",[t._v("First, if you used NPM or Yarn to install the package, make sure you\nhave properly imported HyperFormula as shown below:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" HyperFormula "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hyperformula'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("If you embed HyperFormula in the "),a("code",[t._v(" + \ No newline at end of file diff --git a/guide/arrays.html b/guide/arrays.html index a9cc887be..a11dfc287 100644 --- a/guide/arrays.html +++ b/guide/arrays.html @@ -35,7 +35,7 @@ - + @@ -93,6 +93,6 @@ →

- + \ No newline at end of file diff --git a/guide/basic-operations.html b/guide/basic-operations.html index 856d931ab..15b776a5c 100644 --- a/guide/basic-operations.html +++ b/guide/basic-operations.html @@ -35,7 +35,7 @@ - + @@ -247,7 +247,7 @@ // newValue: 1, // }]

# Demo

This demo presents several basic operations integrated with a -sample UI.

+sample UI.

← →

- + \ No newline at end of file diff --git a/guide/basic-usage.html b/guide/basic-usage.html index 597f207ad..86d4370bb 100644 --- a/guide/basic-usage.html +++ b/guide/basic-usage.html @@ -35,7 +35,7 @@ - + @@ -81,7 +81,7 @@ console.log(mySum);

That's it! You've grasped a basic idea of how the HyperFormula engine works. It's time to move on to a more -advanced example.

# Demo

+advanced example.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/batch-operations.html b/guide/batch-operations.html index 7a8b5f838..617622122 100644 --- a/guide/batch-operations.html +++ b/guide/batch-operations.html @@ -35,7 +35,7 @@ - + @@ -115,7 +115,7 @@ better performance in the application you develop; it will result in faster calculation across the whole HyperFormula instance.

Batching can also be useful when you decide to use HyperFormula on the server-side. Several operations -can be sent as a single one.

# What you can't batch

You can't batch read operations.

Methods such as getCellValue, getSheetSerialized, or getFillRangeData will result in an error when called inside a batch callback or when the evaluation is suspended.

The paste method also can't be called when batching as it reads the contents of the copied cells.

# Demo

+can be sent as a single one.

# What you can't batch

You can't batch read operations.

Methods such as getCellValue, getSheetSerialized, or getFillRangeData will result in an error when called inside a batch callback or when the evaluation is suspended.

The paste method also can't be called when batching as it reads the contents of the copied cells.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/branding.html b/guide/branding.html index 83fcd545d..0b4c31f8f 100644 --- a/guide/branding.html +++ b/guide/branding.html @@ -35,7 +35,7 @@ - + @@ -69,6 +69,6 @@ →

- + \ No newline at end of file diff --git a/guide/building.html b/guide/building.html index 2e2ef6881..4771e26a5 100644 --- a/guide/building.html +++ b/guide/building.html @@ -35,7 +35,7 @@ - + @@ -81,6 +81,6 @@ →

- + \ No newline at end of file diff --git a/guide/built-in-functions.html b/guide/built-in-functions.html index 9b4ae95ca..7647667b6 100644 --- a/guide/built-in-functions.html +++ b/guide/built-in-functions.html @@ -35,7 +35,7 @@ - + @@ -79,6 +79,6 @@ →

- + \ No newline at end of file diff --git a/guide/cell-references.html b/guide/cell-references.html index 9caf79027..2d0d814fc 100644 --- a/guide/cell-references.html +++ b/guide/cell-references.html @@ -35,7 +35,7 @@ - + @@ -112,6 +112,6 @@ →

- + \ No newline at end of file diff --git a/guide/client-side-installation.html b/guide/client-side-installation.html index 855dbaaaf..c4ca992f0 100644 --- a/guide/client-side-installation.html +++ b/guide/client-side-installation.html @@ -35,7 +35,7 @@ - + @@ -86,6 +86,6 @@ →

- + \ No newline at end of file diff --git a/guide/clipboard-operations.html b/guide/clipboard-operations.html index a355b48b9..fe6005701 100644 --- a/guide/clipboard-operations.html +++ b/guide/clipboard-operations.html @@ -35,7 +35,7 @@ - + @@ -87,7 +87,7 @@ // returns a list of modified cells: their absolute addresses and new values const changes = hfInstance.paste({ sheet: 0, col: 1, row: 0 });

If the clipboard is empty, the paste() method doesn't do anything.

# Copy and paste

When called after copy(), the paste() method:

TIP

If a formula =A1 is copied from cell B1 into B2, the B2 formula becomes =A2.

# Cut and paste

When called after cut(), the paste() method:

TIP

If a formula =A1 is cut from cell B1 into B2, the B2 formula becomes =A1.

# Pasting named expressions

If a copied or cut formula contains a named expression defined for a local scope, and the formula is pasted to a sheet that is out of scope for that expression, the expression's scope changes to global.

If the copied or cut named expression's scope is the same as the target's, the expression's local scope remains the same.

# Clear the clipboard

To clear the clipboard, use the clearClipboard() -method.

To check if the clipboard holds any data, use the isClipboardEmpty() method.

# Data storage

The copied or cut data is stored as a memory reference, not directly in the system clipboard.

Depending on what was cut, the data is stored as:

# Demo

+method.

To check if the clipboard holds any data, use the isClipboardEmpty() method.

# Data storage

The copied or cut data is stored as a memory reference, not directly in the system clipboard.

Depending on what was cut, the data is stored as:

# Demo

← →

- + \ No newline at end of file diff --git a/guide/code-of-conduct.html b/guide/code-of-conduct.html index 1a0119e8d..17420a7d5 100644 --- a/guide/code-of-conduct.html +++ b/guide/code-of-conduct.html @@ -35,7 +35,7 @@ - + @@ -116,6 +116,6 @@ →

- + \ No newline at end of file diff --git a/guide/compatibility-with-google-sheets.html b/guide/compatibility-with-google-sheets.html index 385a40be5..3602d34af 100644 --- a/guide/compatibility-with-google-sheets.html +++ b/guide/compatibility-with-google-sheets.html @@ -35,7 +35,7 @@ - + @@ -86,6 +86,6 @@ →

- + \ No newline at end of file diff --git a/guide/compatibility-with-microsoft-excel.html b/guide/compatibility-with-microsoft-excel.html index cd706a004..c4513c8ce 100644 --- a/guide/compatibility-with-microsoft-excel.html +++ b/guide/compatibility-with-microsoft-excel.html @@ -35,7 +35,7 @@ - + @@ -114,6 +114,6 @@ →

- + \ No newline at end of file diff --git a/guide/configuration-options.html b/guide/configuration-options.html index b0773a2b9..446e993a5 100644 --- a/guide/configuration-options.html +++ b/guide/configuration-options.html @@ -35,7 +35,7 @@ - + @@ -76,6 +76,6 @@ →

- + \ No newline at end of file diff --git a/guide/contact.html b/guide/contact.html index 6ad0c4316..2e3a10655 100644 --- a/guide/contact.html +++ b/guide/contact.html @@ -35,7 +35,7 @@ - + @@ -65,6 +65,6 @@

- + \ No newline at end of file diff --git a/guide/contributing.html b/guide/contributing.html index 1bd72ecd6..8ce42268f 100644 --- a/guide/contributing.html +++ b/guide/contributing.html @@ -35,7 +35,7 @@ - + @@ -79,6 +79,6 @@ →

- + \ No newline at end of file diff --git a/guide/custom-functions.html b/guide/custom-functions.html index 165e03601..10ea734d5 100644 --- a/guide/custom-functions.html +++ b/guide/custom-functions.html @@ -35,7 +35,7 @@ - + @@ -269,7 +269,7 @@ });

# Working demo

This demo contains the implementation of both the GREET and -DOUBLE_RANGE custom functions.

# Function options

You can set the following options for your function:

Option Type Description
method (required) String Name of the method that implements the custom function logic.
parameters Array Specification of the arguments accepted by the function and their validation options.
arraySizeMethod String Name of the method that calculates the size of the result array. Not required for functions that never return an array.
returnNumberType String If the function returns a numeric value, this option indicates how to interpret the returned number.
Possible values: NUMBER_RAW, NUMBER_DATE, NUMBER_TIME, NUMBER_DATETIME, NUMBER_CURRENCY, NUMBER_PERCENT.
Default: NUMBER_RAW
repeatLastArgs Number For functions with a variable number of arguments: sets how many last arguments can be repeated indefinitely.
Default: 0
expandRanges Boolean true: ranges in the function's arguments are inlined to (possibly multiple) scalar arguments.
Default: false
isVolatile Boolean true: the function is volatile.
Default: false
isDependentOnSheetStructureChange Boolean true: the function gets recalculated with each sheet shape change (e.g., when adding/removing rows or columns).
Default: false
doesNotNeedArgumentsToBeComputed Boolean true: the function treats reference or range arguments as arguments that don't create dependency (other arguments are properly evaluated).
Default: false
arrayFunction Boolean true: the function enables the array arithmetic mode in its arguments and nested expressions.
Default: false
vectorizationForbidden Boolean true: the function will never get vectorized.
Default: false

You can set the options in the static implementedFunctions property of your +DOUBLE_RANGE custom functions.

# Function options

You can set the following options for your function:

Option Type Description
method (required) String Name of the method that implements the custom function logic.
parameters Array Specification of the arguments accepted by the function and their validation options.
arraySizeMethod String Name of the method that calculates the size of the result array. Not required for functions that never return an array.
returnNumberType String If the function returns a numeric value, this option indicates how to interpret the returned number.
Possible values: NUMBER_RAW, NUMBER_DATE, NUMBER_TIME, NUMBER_DATETIME, NUMBER_CURRENCY, NUMBER_PERCENT.
Default: NUMBER_RAW
repeatLastArgs Number For functions with a variable number of arguments: sets how many last arguments can be repeated indefinitely.
Default: 0
expandRanges Boolean true: ranges in the function's arguments are inlined to (possibly multiple) scalar arguments.
Default: false
isVolatile Boolean true: the function is volatile.
Default: false
isDependentOnSheetStructureChange Boolean true: the function gets recalculated with each sheet shape change (e.g., when adding/removing rows or columns).
Default: false
doesNotNeedArgumentsToBeComputed Boolean true: the function treats reference or range arguments as arguments that don't create dependency (other arguments are properly evaluated).
Default: false
arrayFunction Boolean true: the function enables the array arithmetic mode in its arguments and nested expressions.
Default: false
vectorizationForbidden Boolean true: the function will never get vectorized.
Default: false

You can set the options in the static implementedFunctions property of your function plugin:

MyCustomPlugin.implementedFunctions = {
   MY_FUNCTION: {
     method: 'myFunctionMethod',
@@ -352,6 +352,6 @@
       
       →
- + \ No newline at end of file diff --git a/guide/date-and-time-handling.html b/guide/date-and-time-handling.html index 6d106250d..9b065a39e 100644 --- a/guide/date-and-time-handling.html +++ b/guide/date-and-time-handling.html @@ -35,7 +35,7 @@ - + @@ -100,7 +100,7 @@ };

After that, you should be able to add a dataset with dates in your custom format:

const data = [["31st Jan 00", "2nd Jun 01", "=B1-A1"]];
-

And now, HyperFormula recognizes these values as valid dates and can operate on them.

# Demo

+

And now, HyperFormula recognizes these values as valid dates and can operate on them.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/demo.html b/guide/demo.html index 7ead455d2..c3bf61932 100644 --- a/guide/demo.html +++ b/guide/demo.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Demo

In this demo, you can see how HyperFormula handles basic operations by using API methods, such as:

  • buildEmpty static method to initialize the instance
  • addSheet method to add a new sheet
  • setCellContents method to add content
  • getSheetId method to retrieve the sheet's ID
  • getCellValue method to get the value of a cell
  • calculateFormula method to calculate a formula
  • getCellFormula method to retrieve a formula from a cell

+ (opens new window)

# Demo

In this demo, you can see how HyperFormula handles basic operations by using API methods, such as:

  • buildEmpty static method to initialize the instance
  • addSheet method to add a new sheet
  • setCellContents method to add content
  • getSheetId method to retrieve the sheet's ID
  • getCellValue method to get the value of a cell
  • calculateFormula method to calculate a formula
  • getCellFormula method to retrieve a formula from a cell

← →

- + \ No newline at end of file diff --git a/guide/dependencies.html b/guide/dependencies.html index 3626d476a..19f7c9a61 100644 --- a/guide/dependencies.html +++ b/guide/dependencies.html @@ -35,7 +35,7 @@ - + @@ -66,6 +66,6 @@ →

- + \ No newline at end of file diff --git a/guide/dependency-graph.html b/guide/dependency-graph.html index cf68af30b..ca17f584d 100644 --- a/guide/dependency-graph.html +++ b/guide/dependency-graph.html @@ -35,7 +35,7 @@ - + @@ -118,6 +118,6 @@ →

- + \ No newline at end of file diff --git a/guide/file-import.html b/guide/file-import.html index 723394521..86244ef87 100644 --- a/guide/file-import.html +++ b/guide/file-import.html @@ -35,7 +35,7 @@ - + @@ -105,6 +105,6 @@ →

- + \ No newline at end of file diff --git a/guide/i18n-features.html b/guide/i18n-features.html index 74ad14f0f..14b001972 100644 --- a/guide/i18n-features.html +++ b/guide/i18n-features.html @@ -35,7 +35,7 @@ - + @@ -70,7 +70,7 @@ functionArgSeparator: ';', // might cause incompatibility with other spreadsheets currencySymbol: ['$', 'USD'], localeLang: 'en-US', -

# en-US demo

This demo shows HyperFormula configured for the en-US locale.

+

# en-US demo

This demo shows HyperFormula configured for the en-US locale.

← →

- + \ No newline at end of file diff --git a/guide/integration-with-angular.html b/guide/integration-with-angular.html index b8a6d0e17..da9a277e0 100644 --- a/guide/integration-with-angular.html +++ b/guide/integration-with-angular.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Integration with Angular

Installing HyperFormula in an Angular application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

+ (opens new window)

# Integration with Angular

Installing HyperFormula in an Angular application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/integration-with-react.html b/guide/integration-with-react.html index 376fa3b6f..5ea9de6d4 100644 --- a/guide/integration-with-react.html +++ b/guide/integration-with-react.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Integration with React

Installing HyperFormula in a React application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

+ (opens new window)

# Integration with React

Installing HyperFormula in a React application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/integration-with-svelte.html b/guide/integration-with-svelte.html index 16e89efeb..8ae756243 100644 --- a/guide/integration-with-svelte.html +++ b/guide/integration-with-svelte.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Integration with Svelte

Installing HyperFormula in a Svelte application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

+ (opens new window)

# Integration with Svelte

Installing HyperFormula in a Svelte application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/integration-with-vue.html b/guide/integration-with-vue.html index c332766e4..cdb68e27a 100644 --- a/guide/integration-with-vue.html +++ b/guide/integration-with-vue.html @@ -35,7 +35,7 @@ - + @@ -54,7 +54,7 @@ API Reference GitHub - (opens new window)

# Integration with Vue

Installing HyperFormula in a Vue application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

TIP

This demo uses the Vue 3 (opens new window) framework. If you are looking for an example using Vue 2, check out the code on GitHub (opens new window).

+ (opens new window)

# Integration with Vue

Installing HyperFormula in a Vue application works the same as with vanilla JavaScript.

For more details, see the client-side installation section.

# Demo

TIP

This demo uses the Vue 3 (opens new window) framework. If you are looking for an example using Vue 2, check out the code on GitHub (opens new window).

← →

- + \ No newline at end of file diff --git a/guide/key-concepts.html b/guide/key-concepts.html index 518bec3fc..1c6cc4374 100644 --- a/guide/key-concepts.html +++ b/guide/key-concepts.html @@ -35,7 +35,7 @@ - + @@ -108,6 +108,6 @@ →

- + \ No newline at end of file diff --git a/guide/known-limitations.html b/guide/known-limitations.html index 0fb84b7ad..70fca13fa 100644 --- a/guide/known-limitations.html +++ b/guide/known-limitations.html @@ -35,7 +35,7 @@ - + @@ -75,6 +75,6 @@ →

- + \ No newline at end of file diff --git a/guide/license-key.html b/guide/license-key.html index cd3e96461..8165f025d 100644 --- a/guide/license-key.html +++ b/guide/license-key.html @@ -35,7 +35,7 @@ - + @@ -75,6 +75,6 @@ →

- + \ No newline at end of file diff --git a/guide/licensing.html b/guide/licensing.html index 4ab181b0e..f45cba03d 100644 --- a/guide/licensing.html +++ b/guide/licensing.html @@ -35,7 +35,7 @@ - + @@ -63,6 +63,6 @@ →

- + \ No newline at end of file diff --git a/guide/list-of-differences.html b/guide/list-of-differences.html index 9fded8ff9..60a4a7676 100644 --- a/guide/list-of-differences.html +++ b/guide/list-of-differences.html @@ -35,7 +35,7 @@ - + @@ -69,6 +69,6 @@ →

- + \ No newline at end of file diff --git a/guide/localizing-functions.html b/guide/localizing-functions.html index f5ab5ece4..21d1bc0c6 100644 --- a/guide/localizing-functions.html +++ b/guide/localizing-functions.html @@ -35,7 +35,7 @@ - + @@ -88,7 +88,7 @@ REF: '#REF!', VALUE: '#VALEUR!', } -

# Localizing custom functions

You can localize your custom functions as well. For details, see the Custom functions guide.

# List of supported languages

Language name Language code
British English enGB
American English enUS
Czech csCZ
Danish daDK
Dutch nlNL
Finnish fiFI
French frFR
German deDE
Hungarian huHU
Italian itIT
Norwegian nbNO
Polish plPL
Portuguese ptPT
Russian ruRU
Spanish esES
Swedish svSE
Turkish trTR

# Demo

+

# Localizing custom functions

You can localize your custom functions as well. For details, see the Custom functions guide.

# List of supported languages

Language name Language code
British English enGB
American English enUS
Czech csCZ
Danish daDK
Dutch nlNL
Finnish fiFI
French frFR
German deDE
Hungarian huHU
Italian itIT
Norwegian nbNO
Polish plPL
Portuguese ptPT
Russian ruRU
Spanish esES
Swedish svSE
Turkish trTR

# Demo

← →

- + \ No newline at end of file diff --git a/guide/migration-from-0.6-to-1.0.html b/guide/migration-from-0.6-to-1.0.html index 83b5128f2..4d815d8f9 100644 --- a/guide/migration-from-0.6-to-1.0.html +++ b/guide/migration-from-0.6-to-1.0.html @@ -35,7 +35,7 @@ - + @@ -111,6 +111,6 @@ →

- + \ No newline at end of file diff --git a/guide/migration-from-1.0-to-2.0.html b/guide/migration-from-1.0-to-2.0.html index fd3559ad7..a0ee3a227 100644 --- a/guide/migration-from-1.0-to-2.0.html +++ b/guide/migration-from-1.0-to-2.0.html @@ -35,7 +35,7 @@ - + @@ -71,6 +71,6 @@ →

- + \ No newline at end of file diff --git a/guide/named-expressions.html b/guide/named-expressions.html index 211562cbc..95b33cf3c 100644 --- a/guide/named-expressions.html +++ b/guide/named-expressions.html @@ -35,7 +35,7 @@ - + @@ -109,7 +109,7 @@ errors can be handled to provide a good user experience in the application. It is also possible to check the availability of operations using isItPossibleTo* methods, which are also -described in that section.

# Demo

+described in that section.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/order-of-precendece.html b/guide/order-of-precendece.html index d25d504eb..10c07a08e 100644 --- a/guide/order-of-precendece.html +++ b/guide/order-of-precendece.html @@ -35,7 +35,7 @@ - + @@ -75,6 +75,6 @@ →

- + \ No newline at end of file diff --git a/guide/performance.html b/guide/performance.html index d9d921b7c..33696daba 100644 --- a/guide/performance.html +++ b/guide/performance.html @@ -35,7 +35,7 @@ - + @@ -100,6 +100,6 @@ →

- + \ No newline at end of file diff --git a/guide/release-notes.html b/guide/release-notes.html index 8d9f96d59..07cea4c6a 100644 --- a/guide/release-notes.html +++ b/guide/release-notes.html @@ -35,7 +35,7 @@ - + @@ -223,6 +223,6 @@ →

- + \ No newline at end of file diff --git a/guide/server-side-installation.html b/guide/server-side-installation.html index 87c6eabbd..f4f9ad943 100644 --- a/guide/server-side-installation.html +++ b/guide/server-side-installation.html @@ -35,7 +35,7 @@ - + @@ -75,6 +75,6 @@ →

- + \ No newline at end of file diff --git a/guide/sorting-data.html b/guide/sorting-data.html index 976b10bd8..89c3a2f21 100644 --- a/guide/sorting-data.html +++ b/guide/sorting-data.html @@ -35,7 +35,7 @@ - + @@ -169,7 +169,7 @@ // address: { sheet: 0, col: 0, row: 1 }, // newValue: null, // }] -

# Data sorting demo

The demo below shows how to sort rows in ascending and descending order, based on the results (calculated values) of the cells in the second column.

To see the code, select "Open Sandbox" in the frame's bottom right corner.

+

# Data sorting demo

The demo below shows how to sort rows in ascending and descending order, based on the results (calculated values) of the cells in the second column.

← →

- + \ No newline at end of file diff --git a/guide/specifications-and-limits.html b/guide/specifications-and-limits.html index 1eec23a52..95ece514f 100644 --- a/guide/specifications-and-limits.html +++ b/guide/specifications-and-limits.html @@ -35,7 +35,7 @@ - + @@ -67,6 +67,6 @@ →

- + \ No newline at end of file diff --git a/guide/support.html b/guide/support.html index c093fab96..9cb298e50 100644 --- a/guide/support.html +++ b/guide/support.html @@ -35,7 +35,7 @@ - + @@ -69,6 +69,6 @@ →

- + \ No newline at end of file diff --git a/guide/supported-browsers.html b/guide/supported-browsers.html index 8b504ba9b..959884c7a 100644 --- a/guide/supported-browsers.html +++ b/guide/supported-browsers.html @@ -35,7 +35,7 @@ - + @@ -72,6 +72,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-errors.html b/guide/types-of-errors.html index df476090c..2b272dc2a 100644 --- a/guide/types-of-errors.html +++ b/guide/types-of-errors.html @@ -35,7 +35,7 @@ - + @@ -71,6 +71,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-operators.html b/guide/types-of-operators.html index 9355a70dd..e76c2edd0 100644 --- a/guide/types-of-operators.html +++ b/guide/types-of-operators.html @@ -35,7 +35,7 @@ - + @@ -96,6 +96,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-values.html b/guide/types-of-values.html index 765adab30..f505c205c 100644 --- a/guide/types-of-values.html +++ b/guide/types-of-values.html @@ -35,7 +35,7 @@ - + @@ -95,6 +95,6 @@ →

- + \ No newline at end of file diff --git a/guide/undo-redo.html b/guide/undo-redo.html index bde0df2c1..8af2119ee 100644 --- a/guide/undo-redo.html +++ b/guide/undo-redo.html @@ -35,7 +35,7 @@ - + @@ -63,7 +63,7 @@ CRUD operation.

# isThereSomething* methods

There are two methods which can be used to check the actual state of the undo-redo stack:isThereSomethingToUndo and isThereSomethingToRedo.

# Batch operations

When you batch several operations remember -that undo-redo will recognize them as a single cumulative operation.

# Demo

+that undo-redo will recognize them as a single cumulative operation.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/volatile-functions.html b/guide/volatile-functions.html index da57bc270..b3cf59277 100644 --- a/guide/volatile-functions.html +++ b/guide/volatile-functions.html @@ -35,7 +35,7 @@ - + @@ -85,6 +85,6 @@ →

- + \ No newline at end of file diff --git a/index.html b/index.html index 7f404e3e0..f8689cf54 100644 --- a/index.html +++ b/index.html @@ -35,7 +35,7 @@ - + @@ -79,6 +79,6 @@ →

- + \ No newline at end of file