From f1f06bd25d7b93b87484e81b1f0e42066dd7c056 Mon Sep 17 00:00:00 2001 From: sequba Date: Wed, 10 Apr 2024 09:36:04 +0000 Subject: [PATCH] deploy: 03fefd50912e8c18bb17d0909576275227daf8bd --- 404.html | 8 +- api-template.html => api-ref-readme.html | 14 +- api/classes/config.html | 65 ----- api/classes/emitter.html | 10 +- api/classes/hyperformula.html | 273 +++++++++--------- api/enums/events.html | 10 +- api/globals.html | 10 +- api/index.html | 16 +- api/interfaces/configparams.html | 18 +- api/interfaces/listeners.html | 26 +- api/interfaces/typedemitter.html | 10 +- assets/js/{14.fc597aa3.js => 14.35a95fd5.js} | 2 +- assets/js/{20.6fbe829b.js => 20.6cd8ceff.js} | 14 +- assets/js/25.6277c385.js | 1 - assets/js/25.c3bd68f4.js | 1 + assets/js/26.b36353fc.js | 1 + assets/js/26.ced5b227.js | 1 - assets/js/27.466255ed.js | 1 - assets/js/{28.7823806f.js => 27.b68f50df.js} | 2 +- assets/js/{29.dd3990e2.js => 28.8f1f5da4.js} | 2 +- assets/js/{30.a5e33487.js => 29.ff4f27fc.js} | 2 +- assets/js/30.826eca9c.js | 1 + assets/js/31.74aed731.js | 1 + assets/js/31.d69db2c5.js | 1 - assets/js/32.8ba41b4c.js | 1 - assets/js/{33.46087b17.js => 32.e23940b3.js} | 2 +- assets/js/{34.71b5b766.js => 33.efa2ca8a.js} | 2 +- assets/js/{35.c369b0fc.js => 34.61ab12b3.js} | 2 +- assets/js/{36.b1a38952.js => 35.2ba8f1de.js} | 2 +- assets/js/{37.860c98d1.js => 36.87874ebe.js} | 2 +- assets/js/{38.9afba4e9.js => 37.a20420db.js} | 2 +- assets/js/{39.7284662e.js => 38.a5495b7a.js} | 2 +- assets/js/{40.e59208f7.js => 39.9c275050.js} | 2 +- assets/js/{41.5545f3ad.js => 40.2c098a09.js} | 2 +- assets/js/{42.cf18b86b.js => 41.42833c07.js} | 2 +- assets/js/{43.dfbb1eb6.js => 42.2f924bff.js} | 2 +- assets/js/{44.b3085965.js => 43.93a2ffd2.js} | 2 +- assets/js/{45.2641d5c4.js => 44.24f60e46.js} | 2 +- assets/js/{46.d69977ad.js => 45.5fbdf92d.js} | 2 +- assets/js/{47.e4d4a1ec.js => 46.cdb9500c.js} | 2 +- assets/js/{48.2417b5fe.js => 47.e4b3f370.js} | 2 +- assets/js/{49.17785b72.js => 48.c15683f6.js} | 2 +- assets/js/{50.0961aad3.js => 49.4f1be892.js} | 2 +- assets/js/{51.0b65aa2d.js => 50.deeceee7.js} | 2 +- assets/js/{52.79cac59e.js => 51.1f0d82cb.js} | 2 +- assets/js/{53.0d5c00d8.js => 52.371c7a55.js} | 2 +- assets/js/53.489105f1.js | 1 + assets/js/54.a436b89e.js | 1 - assets/js/{55.e1d8ee72.js => 54.ecf0ef7e.js} | 2 +- assets/js/{56.50a93d40.js => 55.63d94e73.js} | 2 +- assets/js/{57.5f257862.js => 56.a2f69074.js} | 2 +- assets/js/{58.f40035bc.js => 57.f3029014.js} | 2 +- assets/js/{59.b02519d2.js => 58.de3aeb74.js} | 2 +- assets/js/{60.89318f07.js => 59.10f647d0.js} | 2 +- assets/js/{61.a83d9284.js => 60.8e4e20a3.js} | 2 +- assets/js/{62.96782175.js => 61.94ef9bdf.js} | 2 +- assets/js/{63.6cee3a49.js => 62.77b1d9e4.js} | 2 +- assets/js/{64.36598c38.js => 63.8a709a4f.js} | 2 +- assets/js/64.96d8be26.js | 1 + assets/js/65.80fa36d2.js | 1 - assets/js/65.e88e2c97.js | 1 + assets/js/66.a5af20b4.js | 1 - assets/js/{67.aad64834.js => 66.b36e89fd.js} | 2 +- assets/js/{68.6335529a.js => 67.cc709c06.js} | 2 +- assets/js/{69.5b1ee38c.js => 68.3696c8f4.js} | 2 +- assets/js/{70.e65eb561.js => 69.5513a2e6.js} | 2 +- assets/js/{71.46c939d0.js => 70.73c146b8.js} | 2 +- assets/js/{72.0afcf696.js => 71.b3225e7d.js} | 2 +- assets/js/{73.7690ac72.js => 72.5ff76d95.js} | 2 +- assets/js/73.c200c01d.js | 1 + assets/js/{75.378732c5.js => 74.17f5f9a5.js} | 2 +- assets/js/74.d81d5a57.js | 1 - assets/js/{76.69adede7.js => 75.520ca5f4.js} | 2 +- assets/js/{77.26caa7d4.js => 76.c9d1027d.js} | 2 +- assets/js/{78.b769e2b7.js => 77.33977693.js} | 2 +- assets/js/{79.0b6bc55b.js => 78.741e3ffd.js} | 2 +- assets/js/{80.69ca23c4.js => 79.584b5bac.js} | 2 +- assets/js/{81.164df8a0.js => 80.fd99c5ca.js} | 2 +- assets/js/{82.454c7962.js => 81.5685ade5.js} | 2 +- assets/js/{83.c798b80c.js => 82.14b4694f.js} | 2 +- assets/js/{84.4aed484e.js => 83.2eb93489.js} | 2 +- assets/js/84.82bb9bfb.js | 1 + assets/js/85.eb08520b.js | 1 - assets/js/app.f4fd2b1a.js | 16 + assets/js/app.fec0aa70.js | 16 - guide/advanced-usage.html | 10 +- guide/arrays.html | 8 +- guide/basic-operations.html | 10 +- guide/basic-usage.html | 10 +- guide/batch-operations.html | 10 +- guide/branding.html | 8 +- guide/building.html | 8 +- guide/built-in-functions.html | 8 +- guide/cell-references.html | 8 +- guide/client-side-installation.html | 8 +- guide/clipboard-operations.html | 10 +- guide/code-of-conduct.html | 8 +- guide/compatibility-with-google-sheets.html | 12 +- guide/compatibility-with-microsoft-excel.html | 12 +- guide/configuration-options.html | 8 +- guide/contact.html | 10 +- guide/contributing.html | 8 +- guide/custom-functions.html | 10 +- guide/date-and-time-handling.html | 10 +- guide/demo.html | 10 +- guide/dependencies.html | 8 +- guide/dependency-graph.html | 8 +- guide/file-import.html | 10 +- guide/i18n-features.html | 10 +- guide/integration-with-angular.html | 11 +- guide/integration-with-react.html | 10 +- guide/integration-with-svelte.html | 10 +- guide/integration-with-vue.html | 10 +- guide/key-concepts.html | 8 +- guide/known-limitations.html | 8 +- guide/license-key.html | 16 +- guide/licensing.html | 11 +- guide/list-of-differences.html | 8 +- guide/localizing-functions.html | 10 +- guide/migration-from-0.6-to-1.0.html | 8 +- guide/migration-from-1.0-to-2.0.html | 8 +- guide/named-expressions.html | 10 +- guide/order-of-precendece.html | 8 +- guide/performance.html | 8 +- guide/release-notes.html | 40 +-- guide/server-side-installation.html | 8 +- guide/sorting-data.html | 10 +- guide/specifications-and-limits.html | 8 +- guide/support.html | 8 +- guide/supported-browsers.html | 8 +- guide/types-of-errors.html | 8 +- guide/types-of-operators.html | 8 +- guide/types-of-values.html | 8 +- guide/undo-redo.html | 10 +- guide/volatile-functions.html | 8 +- index.html | 39 ++- 136 files changed, 553 insertions(+), 605 deletions(-) rename api-template.html => api-ref-readme.html (77%) delete mode 100644 api/classes/config.html rename assets/js/{14.fc597aa3.js => 14.35a95fd5.js} (99%) rename assets/js/{20.6fbe829b.js => 20.6cd8ceff.js} (97%) delete mode 100644 assets/js/25.6277c385.js create mode 100644 assets/js/25.c3bd68f4.js create mode 100644 assets/js/26.b36353fc.js delete mode 100644 assets/js/26.ced5b227.js delete mode 100644 assets/js/27.466255ed.js rename assets/js/{28.7823806f.js => 27.b68f50df.js} (95%) rename assets/js/{29.dd3990e2.js => 28.8f1f5da4.js} (75%) rename assets/js/{30.a5e33487.js => 29.ff4f27fc.js} (86%) create mode 100644 assets/js/30.826eca9c.js create mode 100644 assets/js/31.74aed731.js delete mode 100644 assets/js/31.d69db2c5.js delete mode 100644 assets/js/32.8ba41b4c.js rename assets/js/{33.46087b17.js => 32.e23940b3.js} (98%) rename assets/js/{34.71b5b766.js => 33.efa2ca8a.js} (90%) rename assets/js/{35.c369b0fc.js => 34.61ab12b3.js} (96%) rename assets/js/{36.b1a38952.js => 35.2ba8f1de.js} (99%) rename assets/js/{37.860c98d1.js => 36.87874ebe.js} (98%) rename assets/js/{38.9afba4e9.js => 37.a20420db.js} (91%) rename assets/js/{39.7284662e.js => 38.a5495b7a.js} (96%) rename assets/js/{40.e59208f7.js => 39.9c275050.js} (97%) rename assets/js/{41.5545f3ad.js => 40.2c098a09.js} (99%) rename assets/js/{42.cf18b86b.js => 41.42833c07.js} (99%) rename assets/js/{43.dfbb1eb6.js => 42.2f924bff.js} (99%) rename assets/js/{44.b3085965.js => 43.93a2ffd2.js} (99%) rename assets/js/{45.2641d5c4.js => 44.24f60e46.js} (96%) rename assets/js/{46.d69977ad.js => 45.5fbdf92d.js} (99%) rename assets/js/{47.e4d4a1ec.js => 46.cdb9500c.js} (99%) rename assets/js/{48.2417b5fe.js => 47.e4b3f370.js} (99%) rename assets/js/{49.17785b72.js => 48.c15683f6.js} (98%) rename assets/js/{50.0961aad3.js => 49.4f1be892.js} (56%) rename assets/js/{51.0b65aa2d.js => 50.deeceee7.js} (98%) rename assets/js/{52.79cac59e.js => 51.1f0d82cb.js} (73%) rename assets/js/{53.0d5c00d8.js => 52.371c7a55.js} (95%) create mode 100644 assets/js/53.489105f1.js delete mode 100644 assets/js/54.a436b89e.js rename assets/js/{55.e1d8ee72.js => 54.ecf0ef7e.js} (97%) rename assets/js/{56.50a93d40.js => 55.63d94e73.js} (99%) rename assets/js/{57.5f257862.js => 56.a2f69074.js} (99%) rename assets/js/{58.f40035bc.js => 57.f3029014.js} (95%) rename assets/js/{59.b02519d2.js => 58.de3aeb74.js} (50%) rename assets/js/{60.89318f07.js => 59.10f647d0.js} (51%) rename assets/js/{61.a83d9284.js => 60.8e4e20a3.js} (66%) rename assets/js/{62.96782175.js => 61.94ef9bdf.js} (74%) rename assets/js/{63.6cee3a49.js => 62.77b1d9e4.js} (99%) rename assets/js/{64.36598c38.js => 63.8a709a4f.js} (98%) create mode 100644 assets/js/64.96d8be26.js delete mode 100644 assets/js/65.80fa36d2.js create mode 100644 assets/js/65.e88e2c97.js delete mode 100644 assets/js/66.a5af20b4.js rename assets/js/{67.aad64834.js => 66.b36e89fd.js} (99%) rename assets/js/{68.6335529a.js => 67.cc709c06.js} (94%) rename assets/js/{69.5b1ee38c.js => 68.3696c8f4.js} (99%) rename assets/js/{70.e65eb561.js => 69.5513a2e6.js} (98%) rename assets/js/{71.46c939d0.js => 70.73c146b8.js} (95%) rename assets/js/{72.0afcf696.js => 71.b3225e7d.js} (98%) rename assets/js/{73.7690ac72.js => 72.5ff76d95.js} (98%) create mode 100644 assets/js/73.c200c01d.js rename assets/js/{75.378732c5.js => 74.17f5f9a5.js} (98%) delete mode 100644 assets/js/74.d81d5a57.js rename assets/js/{76.69adede7.js => 75.520ca5f4.js} (97%) rename assets/js/{77.26caa7d4.js => 76.c9d1027d.js} (99%) rename assets/js/{78.b769e2b7.js => 77.33977693.js} (97%) rename assets/js/{79.0b6bc55b.js => 78.741e3ffd.js} (97%) rename assets/js/{80.69ca23c4.js => 79.584b5bac.js} (98%) rename assets/js/{81.164df8a0.js => 80.fd99c5ca.js} (99%) rename assets/js/{82.454c7962.js => 81.5685ade5.js} (99%) rename assets/js/{83.c798b80c.js => 82.14b4694f.js} (74%) rename assets/js/{84.4aed484e.js => 83.2eb93489.js} (99%) create mode 100644 assets/js/84.82bb9bfb.js delete mode 100644 assets/js/85.eb08520b.js create mode 100644 assets/js/app.f4fd2b1a.js delete mode 100644 assets/js/app.fec0aa70.js diff --git a/404.html b/404.html index 492730a8d..1e783b313 100644 --- a/404.html +++ b/404.html @@ -3,7 +3,7 @@ - HyperFormula (v2.6.2) + HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api-template.html b/api-ref-readme.html similarity index 77% rename from api-template.html rename to api-ref-readme.html index 9004ab8e1..437d2548f 100644 --- a/api-template.html +++ b/api-ref-readme.html @@ -3,7 +3,7 @@ - HyperFormula (v2.6.2) + HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api/classes/config.html b/api/classes/config.html deleted file mode 100644 index 7b2b0a564..000000000 --- a/api/classes/config.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Config | HyperFormula (v2.6.2) - - - - - - - - - - - - - - - - - -
HyperFormula (v2.6.2)

# Config Class

# Constructors

# constructor

+ new Config(options: Partial‹ConfigParams›, showDeprecatedWarns: boolean): Config

Defined in src/Config.ts:617 (opens new window)

Parameters:

Name Type Default
options Partial‹ConfigParams› {}
showDeprecatedWarns boolean true

Returns: Config

# Properties

# accentSensitive Readonly

• accentSensitive: boolean

Defined in src/Config.ts:539 (opens new window)

When set to true, makes string comparison accent-sensitive.

Applies only to comparison operators.

default false

# arrayColumnSeparator Readonly

• arrayColumnSeparator: "," | ";"

Defined in src/Config.ts:549 (opens new window)

Sets a column separator symbol for array notation.

default ','

# arrayRowSeparator Readonly

• arrayRowSeparator: ";" | "|"

Defined in src/Config.ts:551 (opens new window)

Sets a row separator symbol for array notation.

default ';'

# binarySearchThreshold Readonly

• binarySearchThreshold: number

Defined in src/Config.ts:592 (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

# caseFirst Readonly

• caseFirst: "upper" | "lower" | "false"

Defined in src/Config.ts:541 (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 Readonly

• caseSensitive: boolean

Defined in src/Config.ts:535 (opens new window)

When set to true, makes string comparison case-sensitive.

Applies to comparison operators only.

default false

# chooseAddressMappingPolicy Readonly

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in src/Config.ts:537 (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

# currencySymbol Readonly

• currencySymbol: string[]

Defined in src/Config.ts:596 (opens new window)

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default ['$']

# dateFormats Readonly

• dateFormats: string[]

Defined in src/Config.ts:543 (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']

# decimalSeparator Readonly

• decimalSeparator: "." | ","

Defined in src/Config.ts:553 (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 '.'

# evaluateNullToZero Readonly

• evaluateNullToZero: boolean

Defined in src/Config.ts:572 (opens new window)

When set to true, formulas evaluating to null evaluate to 0 instead.

default false

# functionArgSeparator Readonly

• functionArgSeparator: string

Defined in src/Config.ts:547 (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 Readonly

• functionPlugins: FunctionPluginDefinition[]

Defined in src/Config.ts:564 (opens new window)

Lists additional function plugins to be used by the formula interpreter.

default []

# ignorePunctuation Readonly

• ignorePunctuation: boolean

Defined in src/Config.ts:568 (opens new window)

When set to true, string comparison ignores punctuation.

default false

# ignoreWhiteSpace Readonly

• ignoreWhiteSpace: "standard" | "any"

Defined in src/Config.ts:559 (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 Readonly

• language: string

Defined in src/Config.ts:557 (opens new window)

Sets a translation package for function and error names.

For more information, see the Localizing functions guide.

default 'enGB'

# leapYear1900 Readonly

• leapYear1900: boolean

Defined in src/Config.ts:566 (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

# licenseKey Readonly

• licenseKey: string

Defined in src/Config.ts:561 (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

# localeLang Readonly

• localeLang: string

Defined in src/Config.ts:570 (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 Readonly

• matchWholeCell: boolean

Defined in src/Config.ts:617 (opens new window)

# maxColumns Readonly

• maxColumns: number

Defined in src/Config.ts:608 (opens new window)

Sets the maximum number of columns.

default 18.278 (Columns A, B, ..., ZZZ)

# maxRows Readonly

• maxRows: number

Defined in src/Config.ts:606 (opens new window)

Sets the maximum number of rows.

default 40.000

# nullDate Readonly

• nullDate: SimpleDate

Defined in src/Config.ts:594 (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 Readonly

• nullYear: number

Defined in src/Config.ts:574 (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 Readonly

• parseDateTime: function

Defined in src/Config.ts:576 (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

# precisionEpsilon Readonly

• precisionEpsilon: number

Defined in src/Config.ts:582 (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 Readonly

• precisionRounding: number

Defined in src/Config.ts:584 (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 Readonly

• smartRounding: boolean

Defined in src/Config.ts:586 (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

# stringifyDateTime Readonly

• stringifyDateTime: function

Defined in src/Config.ts:578 (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:

▸ (date: SimpleDateTime, formatArg: string): Maybe‹string›

Parameters:

Name Type
date SimpleDateTime
formatArg string

# stringifyDuration Readonly

• stringifyDuration: function

Defined in src/Config.ts:580 (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, formatArg: string): Maybe‹string›

Parameters:

Name Type
time SimpleTime
formatArg string

# thousandSeparator Readonly

• thousandSeparator: "" | "," | " " | "."

Defined in src/Config.ts:555 (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 ''

# timeFormats Readonly

• timeFormats: string[]

Defined in src/Config.ts:545 (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']

# undoLimit Readonly

• undoLimit: number

Defined in src/Config.ts:598 (opens new window)

Sets the number of elements kept in the undo history.

default 20

# useArrayArithmetic Readonly

• useArrayArithmetic: boolean

Defined in src/Config.ts:533 (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 Readonly

• useColumnIndex: boolean

Defined in src/Config.ts:588 (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

# useRegularExpressions Readonly

• useRegularExpressions: boolean

Defined in src/Config.ts:615 (opens new window)

# useStats Readonly

• useStats: boolean

Defined in src/Config.ts:590 (opens new window)

When set to true, enables gathering engine statistics and timings.

Useful for testing and benchmarking.

default false

# useWildcards Readonly

• useWildcards: boolean

Defined in src/Config.ts:616 (opens new window)

# Methods

# getConfig

▸ getConfig(): ConfigParams

Defined in src/Config.ts:755 (opens new window)

Returns: ConfigParams

# mergeConfig

▸ mergeConfig(init: Partial‹ConfigParams›): Config

Defined in src/Config.ts:759 (opens new window)

Parameters:

Name Type
init Partial‹ConfigParams›

Returns: Config

# Object literals

# defaultConfig Static

# ▪ defaultConfig: object

Defined in src/Config.ts:491 (opens new window)

# accentSensitive

• accentSensitive: false = false

Defined in src/Config.ts:492 (opens new window)

# arrayColumnSeparator

• arrayColumnSeparator: "," = ","

Defined in src/Config.ts:510 (opens new window)

# arrayRowSeparator

• arrayRowSeparator: ";" = ";"

Defined in src/Config.ts:511 (opens new window)

# binarySearchThreshold

• binarySearchThreshold: number = 20

Defined in src/Config.ts:493 (opens new window)

# caseFirst

• caseFirst: "lower" = "lower"

Defined in src/Config.ts:496 (opens new window)

# caseSensitive

• caseSensitive: false = false

Defined in src/Config.ts:495 (opens new window)

# chooseAddressMappingPolicy

• chooseAddressMappingPolicy: AlwaysDense‹› = new AlwaysDense()

Defined in src/Config.ts:497 (opens new window)

# currencySymbol

• currencySymbol: string[] = ['$']

Defined in src/Config.ts:494 (opens new window)

# dateFormats

• dateFormats: string[] = ['DD/MM/YYYY', 'DD/MM/YY']

Defined in src/Config.ts:498 (opens new window)

# decimalSeparator

• decimalSeparator: "." = "."

Defined in src/Config.ts:499 (opens new window)

# evaluateNullToZero

• evaluateNullToZero: false = false

Defined in src/Config.ts:500 (opens new window)

# functionArgSeparator

• functionArgSeparator: string = ","

Defined in src/Config.ts:501 (opens new window)

# functionPlugins

• functionPlugins: never[] = []

Defined in src/Config.ts:502 (opens new window)

# ignorePunctuation

• ignorePunctuation: false = false

Defined in src/Config.ts:503 (opens new window)

# ignoreWhiteSpace

• ignoreWhiteSpace: "standard" = "standard"

Defined in src/Config.ts:505 (opens new window)

# language

• language: string = "enGB"

Defined in src/Config.ts:504 (opens new window)

# leapYear1900

• leapYear1900: false = false

Defined in src/Config.ts:507 (opens new window)

# licenseKey

• licenseKey: string = ""

Defined in src/Config.ts:506 (opens new window)

# localeLang

• localeLang: string = "en"

Defined in src/Config.ts:508 (opens new window)

# matchWholeCell

• matchWholeCell: true = true

Defined in src/Config.ts:509 (opens new window)

# maxColumns

• maxColumns: number = 18278

Defined in src/Config.ts:513 (opens new window)

# maxRows

• maxRows: number = 40000

Defined in src/Config.ts:512 (opens new window)

# nullYear

• nullYear: number = 30

Defined in src/Config.ts:514 (opens new window)

# parseDateTime

• parseDateTime: defaultParseToDateTime = defaultParseToDateTime

Defined in src/Config.ts:516 (opens new window)

# precisionEpsilon

• precisionEpsilon: number = 1e-13

Defined in src/Config.ts:517 (opens new window)

# precisionRounding

• precisionRounding: number = 14

Defined in src/Config.ts:518 (opens new window)

# smartRounding

• smartRounding: true = true

Defined in src/Config.ts:519 (opens new window)

# stringifyDateTime

• stringifyDateTime: defaultStringifyDateTime = defaultStringifyDateTime

Defined in src/Config.ts:520 (opens new window)

# stringifyDuration

• stringifyDuration: defaultStringifyDuration = defaultStringifyDuration

Defined in src/Config.ts:521 (opens new window)

# thousandSeparator

• thousandSeparator: "" = ""

Defined in src/Config.ts:523 (opens new window)

# timeFormats

• timeFormats: string[] = ['hh:mm', 'hh:mm:ss.sss']

Defined in src/Config.ts:522 (opens new window)

# undoLimit

• undoLimit: number = 20

Defined in src/Config.ts:524 (opens new window)

# useArrayArithmetic

• useArrayArithmetic: false = false

Defined in src/Config.ts:529 (opens new window)

# useColumnIndex

• useColumnIndex: false = false

Defined in src/Config.ts:527 (opens new window)

# useRegularExpressions

• useRegularExpressions: false = false

Defined in src/Config.ts:525 (opens new window)

# useStats

• useStats: false = false

Defined in src/Config.ts:528 (opens new window)

# useWildcards

• useWildcards: true = true

Defined in src/Config.ts:526 (opens new window)

▪ nullDate: object

Defined in src/Config.ts:515 (opens new window)

  • day: number = 30

  • month: number = 12

  • year: number = 1899

- - - \ No newline at end of file diff --git a/api/classes/emitter.html b/api/classes/emitter.html index 861ef6219..15e966f2b 100644 --- a/api/classes/emitter.html +++ b/api/classes/emitter.html @@ -3,7 +3,7 @@ - Emitter | HyperFormula (v2.6.2) + Emitter | HyperFormula (v2.7.0) + (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 1795221bc..eba926610 100644 --- a/api/classes/hyperformula.html +++ b/api/classes/hyperformula.html @@ -3,7 +3,7 @@ - HyperFormula | HyperFormula (v2.6.2) + HyperFormula | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api/enums/events.html b/api/enums/events.html index 0595805c1..a59c749c9 100644 --- a/api/enums/events.html +++ b/api/enums/events.html @@ -3,7 +3,7 @@ - Events | HyperFormula (v2.6.2) + Events | HyperFormula (v2.7.0) + (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 101cd23f4..977842910 100644 --- a/api/globals.html +++ b/api/globals.html @@ -3,7 +3,7 @@ - HyperFormula API reference | HyperFormula (v2.6.2) + API Reference Overview | HyperFormula (v2.7.0) + (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 ea8f33930..0b40c7ae2 100644 --- a/api/index.html +++ b/api/index.html @@ -3,7 +3,7 @@ - HyperFormula API reference | HyperFormula (v2.6.2) + API Reference Overview | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api/interfaces/configparams.html b/api/interfaces/configparams.html index 3e02f4742..2bf88e750 100644 --- a/api/interfaces/configparams.html +++ b/api/interfaces/configparams.html @@ -3,7 +3,7 @@ - ConfigParams | HyperFormula (v2.6.2) + ConfigParams | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api/interfaces/listeners.html b/api/interfaces/listeners.html index 05002e4e9..27b03bba2 100644 --- a/api/interfaces/listeners.html +++ b/api/interfaces/listeners.html @@ -3,7 +3,7 @@ - Listeners | HyperFormula (v2.6.2) + Listeners | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/api/interfaces/typedemitter.html b/api/interfaces/typedemitter.html index 07fde90d4..d8a2fb822 100644 --- a/api/interfaces/typedemitter.html +++ b/api/interfaces/typedemitter.html @@ -3,7 +3,7 @@ - TypedEmitter | HyperFormula (v2.6.2) + TypedEmitter | HyperFormula (v2.7.0) + (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/14.fc597aa3.js b/assets/js/14.35a95fd5.js similarity index 99% rename from assets/js/14.fc597aa3.js rename to assets/js/14.35a95fd5.js index 545ef33f2..a3d29d831 100644 --- a/assets/js/14.fc597aa3.js +++ b/assets/js/14.35a95fd5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{265:function(t,i,e){"use strict";var n=e(93),r=e(15);t.exports=function(t,i,e){return e.get&&n(e.get,i,{getter:!0}),e.set&&n(e.set,i,{setter:!0}),r.f(t,i,e)}},284:function(t,i,e){},298:function(t,i,e){"use strict";e(23)({target:"Object",stat:!0},{hasOwn:e(7)})},299:function(t,i,e){"use strict";var n=e(0),r=e(4),h=e(265),s=e(300),o=e(3),a=n.RegExp,u=a.prototype;r&&o((function(){var t=!0;try{a(".","d")}catch(i){t=!1}var i={},e="",n=t?"dgimsy":"gimsy",r=function(t,n){Object.defineProperty(i,t,{get:function(){return e+=n,!0}})},h={dotAll:"s",global:"g",ignoreCase:"i",multiline:"m",sticky:"y"};for(var s in t&&(h.hasIndices="d"),h)r(s,h[s]);return Object.getOwnPropertyDescriptor(u,"flags").get.call(i)!==n||e!==n}))&&h(u,"flags",{configurable:!0,get:s})},300:function(t,i,e){"use strict";var n=e(24);t.exports=function(){var t=n(this),i="";return t.hasIndices&&(i+="d"),t.global&&(i+="g"),t.ignoreCase&&(i+="i"),t.multiline&&(i+="m"),t.dotAll&&(i+="s"),t.unicode&&(i+="u"),t.unicodeSets&&(i+="v"),t.sticky&&(i+="y"),i}},301:function(t,i,e){"use strict";var n=e(23),r=e(0),h=e(265),s=e(4),o=TypeError,a=Object.defineProperty,u=r.self!==r;try{if(s){var c=Object.getOwnPropertyDescriptor(r,"self");!u&&c&&c.get&&c.enumerable||h(r,"self",{get:function(){return r},set:function(t){if(this!==r)throw new o("Illegal invocation");a(r,"self",{value:t,writable:!0,configurable:!0,enumerable:!0})},configurable:!0,enumerable:!0})}else n({global:!0,simple:!0,forced:u},{self:r})}catch(t){}},302:function(t,i,e){var n,r,h;r=[],void 0===(h="function"==typeof(n=function(){function t(t){o(r(t.target.getAttribute("label"),"terminal","label"),"diagramRectUsage")}function i(t){var i,e,n,a,u=(i=t.target,e=i.getAttribute("rulename"),n=r(e,"non-terminal","rulename"),a=h(e),{rects:n,header:a,ruleName:e});o(u.rects,"diagramRectUsage"),s(u.header,"diagramHeaderDef")}function e(t){var i,e,n,r,s,o,a,c=h(t.target.getAttribute("rulename"));i=c.offsetTop,e=666,n="easeInOutQuint",r=window.scrollY,i=i||0,e=e||2e3,n=n||"easeOutSine",s=0,o=Math.max(.1,Math.min(Math.abs(r-i)/e,.8)),Math.PI,a={easeOutSine:function(t){return Math.sin(t*(Math.PI/2))},easeInOutSine:function(t){return-.5*(Math.cos(Math.PI*t)-1)},easeInOutQuint:function(t){return(t/=.5)<1?.5*Math.pow(t,5):.5*(Math.pow(t-2,5)+2)}},function t(){var e=(s+=1/60)/o,h=a[n](e);e<1?(u(t),window.scrollTo(0,r+(i-r)*h)):window.scrollTo(0,i)}()}function n(t){s(t.target,"diagramHeaderDef"),o(r(t.target.innerHTML,"non-terminal","rulename"),"diagramRectUsage")}function r(t,i,e){return c(a(document.getElementsByClassName(i)),"rect").filter((function(i){return i.parentNode.getElementsByTagName("text")[0].getAttribute(e)===t}))}function h(t){return a(document.getElementsByClassName("diagramHeader")).find((function(i){return i.innerHTML===t}))}function s(t,i){t.classList.contains(i)?t.classList.remove(i):t.classList.add(i)}function o(t,i){t.forEach((function(t){s(t,i)}))}function a(t){return Array.prototype.slice.call(t)}var u=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||function(t){window.setTimeout(t,1e3/60)};function c(t,i){var e=[];return t.forEach((function(t){a(t.children).forEach((function(t){t.tagName===i&&e.push(t)}))})),e}return{initDiagramsBehavior:function(r){void 0===r&&(r=!0),a(document.getElementsByClassName("diagramHeader")).forEach((function(t){t.addEventListener("mouseover",n),t.addEventListener("mouseout",n)})),c(a(document.getElementsByClassName("non-terminal")),"text").forEach((function(t){t.addEventListener("mouseover",i),t.addEventListener("mouseout",i),r&&t.addEventListener("click",e)})),c(a(document.getElementsByClassName("terminal")),"text").forEach((function(i){i.addEventListener("mouseover",t),i.addEventListener("mouseout",t)}))}}})?n.apply(i,r):n)||(t.exports=h)},303:function(t,i,e){var n,r,h;r=[e(304)],void 0===(h="function"==typeof(n=function(t){var i=t.Diagram,e=t.Sequence,n=t.Choice,r=t.Optional,h=t.OneOrMore,s=t.ZeroOrMore,o=(t.Terminal,t.NonTerminal);function a(i,e,n){var r=void 0;return"string"!=typeof i.pattern&&"[object RegExp]"!==Object.prototype.toString.call(i.pattern)||(r=i.pattern),t.Terminal(i.label,void 0,r,i.occurrenceInParent,e,n,i.name)}function u(t,c){if("NonTerminal"===t.type)return o(function(t){return void 0!==t.nonTerminalName?t.nonTerminalName:t.name}(t),void 0,t.occurrenceInParent,c);if("Terminal"===t.type){if("Terminal"===t.type)return a(t,c,"consume");throw Error("non exhaustive match")}var d=function(t,i){return t.map((function(t){return u(t,i)}))}(t.definition,c);if("Rule"===t.type)return i.apply(this,d);if("Flat"===t.type)return e.apply(this,d);if("Option"===t.type){if(d.length>1)return r(e.apply(this,d));if(1===d.length)return r(d[0]);throw Error("Empty Optional production, OOPS!")}if("Repetition"===t.type){if(d.length>1)return s(e.apply(this,d));if(1===d.length)return s(d[0]);throw Error("Empty Optional production, OOPS!")}if("Alternation"===t.type)return n.apply(this,[0].concat(d));if("RepetitionMandatory"===t.type){if(d.length>1)return h(e.apply(this,d));if(1===d.length)return h(d[0]);throw Error("Empty Optional production, OOPS!")}if("RepetitionWithSeparator"===t.type){if(d.length>0)return r(e.apply(this,d.concat([s(e.apply(this,[a(t.separator,c,"many_sep")].concat(d)))])));throw Error("Empty Optional production, OOPS!")}if("RepetitionMandatoryWithSeparator"===t.type){if(d.length>0)return e.apply(this,d.concat([s(e.apply(this,[a(t.separator,c,"at_least_one_sep")].concat(d)))]));throw Error("Empty Optional production, OOPS!")}}return{buildSyntaxDiagramsText:function(t){var i="";return t.forEach((function(t){var e=u(t,t.name);i+='

'+t.name+"

"+e})),i},convertProductionToDiagram:u}})?n.apply(i,r):n)||(t.exports=h)},304:function(t,i,e){var n;(function(e){function r(t,i){t.prototype=Object.create(i.prototype),t.prototype.$super=i.prototype}function h(){return[].slice.call(arguments).reduce((function(t,i){return void 0!==t?t:i}))}function s(t,i){var e=t-i;switch(d.INTERNAL_ALIGNMENT){case"left":return[0,e];case"right":return[e,0];case"center":default:return[e/2,e/2]}}function o(t){return"string"==typeof t?new y(t):t}function a(t){for(var i=0;i\n"},r(c,u),c.prototype.m=function(t,i){return this.attrs.d+="m"+t+" "+i,this},c.prototype.h=function(t){return this.attrs.d+="h"+t,this},c.prototype.right=c.prototype.h,c.prototype.left=function(t){return this.h(-t)},c.prototype.v=function(t){return this.attrs.d+="v"+t,this},c.prototype.down=c.prototype.v,c.prototype.up=function(t){return this.v(-t)},c.prototype.arc=function(t){var i=d.ARC_RADIUS,e=d.ARC_RADIUS;if("e"!=t[0]&&"w"!=t[1]||(i*=-1),"s"!=t[0]&&"n"!=t[1]||(e*=-1),"ne"==t||"es"==t||"sw"==t||"wn"==t)var n=1;else n=0;return this.attrs.d+="a"+d.ARC_RADIUS+" "+d.ARC_RADIUS+" 0 0 "+n+" "+i+" "+e,this},c.prototype.format=function(){return this.attrs.d+="h.5",this},r(d,u),e)d[f]=e[f];function p(t){if(!(this instanceof p))return new p([].slice.call(arguments));if(u.call(this,"g"),a(t))throw new RangeError("Stack() must only occur at the very last position of Sequence().");this.items=t.map(o),this.width=this.items.reduce((function(t,i){return t+i.width+(i.needsSpace?20:0)}),0),this.offsetX=0,this.height=this.items.reduce((function(t,i){return t+i.height}),0),this.up=this.items.reduce((function(t,i){return Math.max(t,i.up)}),0),this.down=this.items.reduce((function(t,i){return Math.max(t,i.down)}),0)}function m(t){if(!(this instanceof m))return new m([].slice.call(arguments));if(u.call(this,"g"),a(t))throw new RangeError("Stack() must only occur at the very last position of Stack().");if(0===t.length)throw new RangeError("Stack() must have at least one child.");this.items=t.map(o),this.width=this.items.reduce((function(t,i){return Math.max(t,i.width+(i.needsSpace?20:0))}),0),this.items.length>1&&(this.width+=2*d.ARC_RADIUS),this.up=this.items[0].up,this.down=this.items[this.items.length-1].down,this.height=0;for(var i=0;i1&&(this.offsetX+=2*d.ARC_RADIUS))}function l(t,i){if(!(this instanceof l))return new l(t,[].slice.call(arguments,1));if(u.call(this,"g"),"number"!=typeof t||t!==Math.floor(t))throw new TypeError("The first argument of Choice() must be an integer.");if(t<0||t>=i.length)throw new RangeError("The first argument of Choice() must be an index for one of the items.");this.normal=t,this.items=i.map(o),this.width=this.items.reduce((function(t,i){return Math.max(t,i.width)}),0)+4*d.ARC_RADIUS,this.offsetX=0,this.height=this.items[t].height,this.up=this.down=0;for(var e=0;et&&(this.down+=Math.max(d.ARC_RADIUS,d.VERTICAL_SEPARATION+n.up+n.down+n.height))}}function g(t,i){if(void 0===i)return l(1,v(),t);if("skip"===i)return l(0,v(),t);throw"Unknown value for Optional()'s 'skip' argument."}function w(t,i){if(!(this instanceof w))return new w(t,i);u.call(this,"g"),i=i||new v,this.item=o(t),this.rep=o(i),this.width=Math.max(this.item.width,this.rep.width)+2*d.ARC_RADIUS,this.offsetX=0,this.height=this.item.height,this.up=this.item.up,this.down=Math.max(2*d.ARC_RADIUS,this.item.down+d.VERTICAL_SEPARATION+this.rep.up+this.rep.height+this.rep.down)}function A(t){if(!(this instanceof A))return new A;u.call(this,"path"),this.width=20,this.height=0,this.offsetX=0,this.up=10,this.down=10,this.simpleType=t}function R(t){if(!(this instanceof R))return new R;u.call(this,"path"),this.width=20,this.height=0,this.offsetX=0,this.up=10,this.down=10,this.simpleType=t}function y(t,i,e,n,r,h,s){if(!(this instanceof y))return new y(t,i,e,n,r,h,s);u.call(this,"g",{class:"terminal"}),this.text=t,this.label=t,this.href=i,this.title=e,this.occurrenceIdx=n,this.topRuleName=r,this.dslRuleName=h,this.tokenName=s,this.width=8*t.length+20,this.height=0,this.offsetX=0,this.up=11,this.down=11}function S(t,i,e,n){if(!(this instanceof S))return new S(t,i,e,n);u.call(this,"g",{class:"non-terminal"}),this.text=t,this.ruleName=t,this.href=i,this.occurrenceIdx=e,this.topRuleName=n,this.width=8*t.length+20,this.height=0,this.offsetX=0,this.up=11,this.down=11}function T(t){if(!(this instanceof T))return new T(t);u.call(this,"g"),this.text=t,this.width=7*t.length+10,this.height=0,this.offsetX=0,this.up=11,this.down=11}function v(){if(!(this instanceof v))return new v;u.call(this,"g"),this.width=0,this.height=0,this.offsetX=0,this.up=0,this.down=0}var I;d.prototype.format=function(t,i,e,n){t=h(t,20),i=h(i,t,20),e=h(e,t,20);var r=n=h(n,i,20),s=t;s+=this.up;for(var o=u("g",d.STROKE_ODD_PIXEL_LENGTH?{transform:"translate(.5 .5)"}:{}),a=0;a=0;o--){var a=this.items[o];if(o==this.normal-1)var u=Math.max(2*d.ARC_RADIUS,this.items[o+1].up+d.VERTICAL_SEPARATION+a.height+a.down);c(t,i).arc("se").up(u-2*d.ARC_RADIUS).arc("wn").addTo(this),a.format(t+2*d.ARC_RADIUS,i-u,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i-u+a.height).arc("ne").down(u-a.height+this.items[this.normal].height-2*d.ARC_RADIUS).arc("ws").addTo(this),u+=Math.max(d.ARC_RADIUS,a.up+d.VERTICAL_SEPARATION+(0==o?0:this.items[o-1].down+this.items[o-1].height))}c(t,i).right(2*d.ARC_RADIUS).addTo(this),this.items[this.normal].format(t+2*d.ARC_RADIUS,i,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i+this.height).right(2*d.ARC_RADIUS).addTo(this);for(o=this.normal+1;o<=r;o++){a=this.items[o];if(o==this.normal+1)u=Math.max(2*d.ARC_RADIUS,this.items[o-1].height+this.items[o-1].down+d.VERTICAL_SEPARATION+a.up);c(t,i).arc("ne").down(u-2*d.ARC_RADIUS).arc("ws").addTo(this),a.format(t+2*d.ARC_RADIUS,i+u,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i+u+a.height).arc("se").up(u-2*d.ARC_RADIUS+a.height-this.items[this.normal].height).arc("wn").addTo(this),u+=Math.max(d.ARC_RADIUS,a.height+a.down+d.VERTICAL_SEPARATION+(o==r?0:this.items[o+1].up))}return this},r(w,u),w.prototype.needsSpace=!0,w.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i+this.height).h(n[1]).addTo(this),c(t+=n[0],i).right(d.ARC_RADIUS).addTo(this),this.item.format(t+d.ARC_RADIUS,i,this.width-2*d.ARC_RADIUS).addTo(this),c(t+this.width-d.ARC_RADIUS,i+this.height).right(d.ARC_RADIUS).addTo(this);var r=Math.max(2*d.ARC_RADIUS,this.item.height+this.item.down+d.VERTICAL_SEPARATION+this.rep.up);return c(t+d.ARC_RADIUS,i).arc("nw").down(r-2*d.ARC_RADIUS).arc("ws").addTo(this),this.rep.format(t+d.ARC_RADIUS,i+r,this.width-2*d.ARC_RADIUS).addTo(this),c(t+this.width-d.ARC_RADIUS,i+r+this.rep.height).arc("se").up(r-2*d.ARC_RADIUS+this.rep.height-this.item.height).arc("en").addTo(this),this},r(A,u),A.prototype.format=function(t,i){return!1===this.simpleType?this.attrs.d="M "+t+" "+(i-10)+" v 20 m 0 -10 h 20.5":this.attrs.d="M "+t+" "+(i-10)+" v 20 m 10 -20 v 20 m -10 -10 h 20.5",this},r(R,u),R.prototype.format=function(t,i){return!1===this.simpleType?this.attrs.d="M "+t+" "+i+" h 20 m 0 -10 v 20":this.attrs.d="M "+t+" "+i+" h 20 m -10 -10 v 20 m 10 -20 v 20",this},r(y,u),y.prototype.needsSpace=!0,y.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i).h(n[1]).addTo(this),u("rect",{x:t+=n[0],y:i-11,width:this.width,height:this.up+this.down,rx:10,ry:10}).addTo(this);var r=u("text",{x:t+this.width/2,y:i+4,occurrenceIdx:this.occurrenceIdx,topRuleName:this.topRuleName,dslRuleName:this.dslRuleName,tokenName:this.tokenName,label:this.label},this.text),h=u("title",{},this.title);return this.href?u("a",{"xlink:href":this.href},[r]).addTo(this):(r.addTo(this),void 0!==this.title&&h.addTo(this)),this},r(S,u),S.prototype.needsSpace=!0,S.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i).h(n[1]).addTo(this),u("rect",{x:t+=n[0],y:i-11,width:this.width,height:this.up+this.down}).addTo(this);var r=u("text",{x:t+this.width/2,y:i+4,occurrenceIdx:this.occurrenceIdx,topRuleName:this.topRuleName,ruleName:this.ruleName},this.text);return this.href?u("a",{"xlink:href":this.href},[r]).addTo(this):r.addTo(this),this},r(T,u),T.prototype.needsSpace=!0,T.prototype.format=function(t,i,e){var n=s(e,this.width);return c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i+this.height).h(n[1]).addTo(this),u("text",{x:(t+=n[0])+this.width/2,y:i+5,class:"comment"},this.text).addTo(this),this},r(v,u),v.prototype.format=function(t,i,e){return c(t,i).right(e).addTo(this),this},I={},void 0===(n=function(){return I}.apply(i,[]))||(t.exports=n);var E=[d,function(){var t=new d([].slice.call(arguments)),i=t.items;return i.shift(),i.pop(),i.unshift(new A(!1)),i.push(new R(!1)),t.items=i,t},p,m,l,g,w,function(t,i,e){return g(w(t,i),e)},y,S,T,v];["Diagram","ComplexDiagram","Sequence","Stack","Choice","Optional","OneOrMore","ZeroOrMore","Terminal","NonTerminal","Comment","Skip"].forEach((function(t,i){I[t]=E[i]}))}).call(this,{VERTICAL_SEPARATION:8,ARC_RADIUS:10,DIAGRAM_CLASS:"railroad-diagram",STROKE_ODD_PIXEL_LENGTH:!0,INTERNAL_ALIGNMENT:"center"})},305:function(t,i,e){"use strict";e(284)}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{265:function(t,i,e){"use strict";var n=e(93),r=e(15);t.exports=function(t,i,e){return e.get&&n(e.get,i,{getter:!0}),e.set&&n(e.set,i,{setter:!0}),r.f(t,i,e)}},284:function(t,i,e){},298:function(t,i,e){"use strict";e(23)({target:"Object",stat:!0},{hasOwn:e(8)})},299:function(t,i,e){"use strict";var n=e(0),r=e(4),h=e(265),s=e(300),o=e(3),a=n.RegExp,u=a.prototype;r&&o((function(){var t=!0;try{a(".","d")}catch(i){t=!1}var i={},e="",n=t?"dgimsy":"gimsy",r=function(t,n){Object.defineProperty(i,t,{get:function(){return e+=n,!0}})},h={dotAll:"s",global:"g",ignoreCase:"i",multiline:"m",sticky:"y"};for(var s in t&&(h.hasIndices="d"),h)r(s,h[s]);return Object.getOwnPropertyDescriptor(u,"flags").get.call(i)!==n||e!==n}))&&h(u,"flags",{configurable:!0,get:s})},300:function(t,i,e){"use strict";var n=e(45);t.exports=function(){var t=n(this),i="";return t.hasIndices&&(i+="d"),t.global&&(i+="g"),t.ignoreCase&&(i+="i"),t.multiline&&(i+="m"),t.dotAll&&(i+="s"),t.unicode&&(i+="u"),t.unicodeSets&&(i+="v"),t.sticky&&(i+="y"),i}},301:function(t,i,e){"use strict";var n=e(23),r=e(0),h=e(265),s=e(4),o=TypeError,a=Object.defineProperty,u=r.self!==r;try{if(s){var c=Object.getOwnPropertyDescriptor(r,"self");!u&&c&&c.get&&c.enumerable||h(r,"self",{get:function(){return r},set:function(t){if(this!==r)throw new o("Illegal invocation");a(r,"self",{value:t,writable:!0,configurable:!0,enumerable:!0})},configurable:!0,enumerable:!0})}else n({global:!0,simple:!0,forced:u},{self:r})}catch(t){}},302:function(t,i,e){var n,r,h;r=[],void 0===(h="function"==typeof(n=function(){function t(t){o(r(t.target.getAttribute("label"),"terminal","label"),"diagramRectUsage")}function i(t){var i,e,n,a,u=(i=t.target,e=i.getAttribute("rulename"),n=r(e,"non-terminal","rulename"),a=h(e),{rects:n,header:a,ruleName:e});o(u.rects,"diagramRectUsage"),s(u.header,"diagramHeaderDef")}function e(t){var i,e,n,r,s,o,a,c=h(t.target.getAttribute("rulename"));i=c.offsetTop,e=666,n="easeInOutQuint",r=window.scrollY,i=i||0,e=e||2e3,n=n||"easeOutSine",s=0,o=Math.max(.1,Math.min(Math.abs(r-i)/e,.8)),Math.PI,a={easeOutSine:function(t){return Math.sin(t*(Math.PI/2))},easeInOutSine:function(t){return-.5*(Math.cos(Math.PI*t)-1)},easeInOutQuint:function(t){return(t/=.5)<1?.5*Math.pow(t,5):.5*(Math.pow(t-2,5)+2)}},function t(){var e=(s+=1/60)/o,h=a[n](e);e<1?(u(t),window.scrollTo(0,r+(i-r)*h)):window.scrollTo(0,i)}()}function n(t){s(t.target,"diagramHeaderDef"),o(r(t.target.innerHTML,"non-terminal","rulename"),"diagramRectUsage")}function r(t,i,e){return c(a(document.getElementsByClassName(i)),"rect").filter((function(i){return i.parentNode.getElementsByTagName("text")[0].getAttribute(e)===t}))}function h(t){return a(document.getElementsByClassName("diagramHeader")).find((function(i){return i.innerHTML===t}))}function s(t,i){t.classList.contains(i)?t.classList.remove(i):t.classList.add(i)}function o(t,i){t.forEach((function(t){s(t,i)}))}function a(t){return Array.prototype.slice.call(t)}var u=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||function(t){window.setTimeout(t,1e3/60)};function c(t,i){var e=[];return t.forEach((function(t){a(t.children).forEach((function(t){t.tagName===i&&e.push(t)}))})),e}return{initDiagramsBehavior:function(r){void 0===r&&(r=!0),a(document.getElementsByClassName("diagramHeader")).forEach((function(t){t.addEventListener("mouseover",n),t.addEventListener("mouseout",n)})),c(a(document.getElementsByClassName("non-terminal")),"text").forEach((function(t){t.addEventListener("mouseover",i),t.addEventListener("mouseout",i),r&&t.addEventListener("click",e)})),c(a(document.getElementsByClassName("terminal")),"text").forEach((function(i){i.addEventListener("mouseover",t),i.addEventListener("mouseout",t)}))}}})?n.apply(i,r):n)||(t.exports=h)},303:function(t,i,e){var n,r,h;r=[e(304)],void 0===(h="function"==typeof(n=function(t){var i=t.Diagram,e=t.Sequence,n=t.Choice,r=t.Optional,h=t.OneOrMore,s=t.ZeroOrMore,o=(t.Terminal,t.NonTerminal);function a(i,e,n){var r=void 0;return"string"!=typeof i.pattern&&"[object RegExp]"!==Object.prototype.toString.call(i.pattern)||(r=i.pattern),t.Terminal(i.label,void 0,r,i.occurrenceInParent,e,n,i.name)}function u(t,c){if("NonTerminal"===t.type)return o(function(t){return void 0!==t.nonTerminalName?t.nonTerminalName:t.name}(t),void 0,t.occurrenceInParent,c);if("Terminal"===t.type){if("Terminal"===t.type)return a(t,c,"consume");throw Error("non exhaustive match")}var d=function(t,i){return t.map((function(t){return u(t,i)}))}(t.definition,c);if("Rule"===t.type)return i.apply(this,d);if("Flat"===t.type)return e.apply(this,d);if("Option"===t.type){if(d.length>1)return r(e.apply(this,d));if(1===d.length)return r(d[0]);throw Error("Empty Optional production, OOPS!")}if("Repetition"===t.type){if(d.length>1)return s(e.apply(this,d));if(1===d.length)return s(d[0]);throw Error("Empty Optional production, OOPS!")}if("Alternation"===t.type)return n.apply(this,[0].concat(d));if("RepetitionMandatory"===t.type){if(d.length>1)return h(e.apply(this,d));if(1===d.length)return h(d[0]);throw Error("Empty Optional production, OOPS!")}if("RepetitionWithSeparator"===t.type){if(d.length>0)return r(e.apply(this,d.concat([s(e.apply(this,[a(t.separator,c,"many_sep")].concat(d)))])));throw Error("Empty Optional production, OOPS!")}if("RepetitionMandatoryWithSeparator"===t.type){if(d.length>0)return e.apply(this,d.concat([s(e.apply(this,[a(t.separator,c,"at_least_one_sep")].concat(d)))]));throw Error("Empty Optional production, OOPS!")}}return{buildSyntaxDiagramsText:function(t){var i="";return t.forEach((function(t){var e=u(t,t.name);i+='

'+t.name+"

"+e})),i},convertProductionToDiagram:u}})?n.apply(i,r):n)||(t.exports=h)},304:function(t,i,e){var n;(function(e){function r(t,i){t.prototype=Object.create(i.prototype),t.prototype.$super=i.prototype}function h(){return[].slice.call(arguments).reduce((function(t,i){return void 0!==t?t:i}))}function s(t,i){var e=t-i;switch(d.INTERNAL_ALIGNMENT){case"left":return[0,e];case"right":return[e,0];case"center":default:return[e/2,e/2]}}function o(t){return"string"==typeof t?new y(t):t}function a(t){for(var i=0;i\n"},r(c,u),c.prototype.m=function(t,i){return this.attrs.d+="m"+t+" "+i,this},c.prototype.h=function(t){return this.attrs.d+="h"+t,this},c.prototype.right=c.prototype.h,c.prototype.left=function(t){return this.h(-t)},c.prototype.v=function(t){return this.attrs.d+="v"+t,this},c.prototype.down=c.prototype.v,c.prototype.up=function(t){return this.v(-t)},c.prototype.arc=function(t){var i=d.ARC_RADIUS,e=d.ARC_RADIUS;if("e"!=t[0]&&"w"!=t[1]||(i*=-1),"s"!=t[0]&&"n"!=t[1]||(e*=-1),"ne"==t||"es"==t||"sw"==t||"wn"==t)var n=1;else n=0;return this.attrs.d+="a"+d.ARC_RADIUS+" "+d.ARC_RADIUS+" 0 0 "+n+" "+i+" "+e,this},c.prototype.format=function(){return this.attrs.d+="h.5",this},r(d,u),e)d[f]=e[f];function p(t){if(!(this instanceof p))return new p([].slice.call(arguments));if(u.call(this,"g"),a(t))throw new RangeError("Stack() must only occur at the very last position of Sequence().");this.items=t.map(o),this.width=this.items.reduce((function(t,i){return t+i.width+(i.needsSpace?20:0)}),0),this.offsetX=0,this.height=this.items.reduce((function(t,i){return t+i.height}),0),this.up=this.items.reduce((function(t,i){return Math.max(t,i.up)}),0),this.down=this.items.reduce((function(t,i){return Math.max(t,i.down)}),0)}function m(t){if(!(this instanceof m))return new m([].slice.call(arguments));if(u.call(this,"g"),a(t))throw new RangeError("Stack() must only occur at the very last position of Stack().");if(0===t.length)throw new RangeError("Stack() must have at least one child.");this.items=t.map(o),this.width=this.items.reduce((function(t,i){return Math.max(t,i.width+(i.needsSpace?20:0))}),0),this.items.length>1&&(this.width+=2*d.ARC_RADIUS),this.up=this.items[0].up,this.down=this.items[this.items.length-1].down,this.height=0;for(var i=0;i1&&(this.offsetX+=2*d.ARC_RADIUS))}function l(t,i){if(!(this instanceof l))return new l(t,[].slice.call(arguments,1));if(u.call(this,"g"),"number"!=typeof t||t!==Math.floor(t))throw new TypeError("The first argument of Choice() must be an integer.");if(t<0||t>=i.length)throw new RangeError("The first argument of Choice() must be an index for one of the items.");this.normal=t,this.items=i.map(o),this.width=this.items.reduce((function(t,i){return Math.max(t,i.width)}),0)+4*d.ARC_RADIUS,this.offsetX=0,this.height=this.items[t].height,this.up=this.down=0;for(var e=0;et&&(this.down+=Math.max(d.ARC_RADIUS,d.VERTICAL_SEPARATION+n.up+n.down+n.height))}}function g(t,i){if(void 0===i)return l(1,v(),t);if("skip"===i)return l(0,v(),t);throw"Unknown value for Optional()'s 'skip' argument."}function w(t,i){if(!(this instanceof w))return new w(t,i);u.call(this,"g"),i=i||new v,this.item=o(t),this.rep=o(i),this.width=Math.max(this.item.width,this.rep.width)+2*d.ARC_RADIUS,this.offsetX=0,this.height=this.item.height,this.up=this.item.up,this.down=Math.max(2*d.ARC_RADIUS,this.item.down+d.VERTICAL_SEPARATION+this.rep.up+this.rep.height+this.rep.down)}function A(t){if(!(this instanceof A))return new A;u.call(this,"path"),this.width=20,this.height=0,this.offsetX=0,this.up=10,this.down=10,this.simpleType=t}function R(t){if(!(this instanceof R))return new R;u.call(this,"path"),this.width=20,this.height=0,this.offsetX=0,this.up=10,this.down=10,this.simpleType=t}function y(t,i,e,n,r,h,s){if(!(this instanceof y))return new y(t,i,e,n,r,h,s);u.call(this,"g",{class:"terminal"}),this.text=t,this.label=t,this.href=i,this.title=e,this.occurrenceIdx=n,this.topRuleName=r,this.dslRuleName=h,this.tokenName=s,this.width=8*t.length+20,this.height=0,this.offsetX=0,this.up=11,this.down=11}function S(t,i,e,n){if(!(this instanceof S))return new S(t,i,e,n);u.call(this,"g",{class:"non-terminal"}),this.text=t,this.ruleName=t,this.href=i,this.occurrenceIdx=e,this.topRuleName=n,this.width=8*t.length+20,this.height=0,this.offsetX=0,this.up=11,this.down=11}function T(t){if(!(this instanceof T))return new T(t);u.call(this,"g"),this.text=t,this.width=7*t.length+10,this.height=0,this.offsetX=0,this.up=11,this.down=11}function v(){if(!(this instanceof v))return new v;u.call(this,"g"),this.width=0,this.height=0,this.offsetX=0,this.up=0,this.down=0}var I;d.prototype.format=function(t,i,e,n){t=h(t,20),i=h(i,t,20),e=h(e,t,20);var r=n=h(n,i,20),s=t;s+=this.up;for(var o=u("g",d.STROKE_ODD_PIXEL_LENGTH?{transform:"translate(.5 .5)"}:{}),a=0;a=0;o--){var a=this.items[o];if(o==this.normal-1)var u=Math.max(2*d.ARC_RADIUS,this.items[o+1].up+d.VERTICAL_SEPARATION+a.height+a.down);c(t,i).arc("se").up(u-2*d.ARC_RADIUS).arc("wn").addTo(this),a.format(t+2*d.ARC_RADIUS,i-u,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i-u+a.height).arc("ne").down(u-a.height+this.items[this.normal].height-2*d.ARC_RADIUS).arc("ws").addTo(this),u+=Math.max(d.ARC_RADIUS,a.up+d.VERTICAL_SEPARATION+(0==o?0:this.items[o-1].down+this.items[o-1].height))}c(t,i).right(2*d.ARC_RADIUS).addTo(this),this.items[this.normal].format(t+2*d.ARC_RADIUS,i,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i+this.height).right(2*d.ARC_RADIUS).addTo(this);for(o=this.normal+1;o<=r;o++){a=this.items[o];if(o==this.normal+1)u=Math.max(2*d.ARC_RADIUS,this.items[o-1].height+this.items[o-1].down+d.VERTICAL_SEPARATION+a.up);c(t,i).arc("ne").down(u-2*d.ARC_RADIUS).arc("ws").addTo(this),a.format(t+2*d.ARC_RADIUS,i+u,h).addTo(this),c(t+2*d.ARC_RADIUS+h,i+u+a.height).arc("se").up(u-2*d.ARC_RADIUS+a.height-this.items[this.normal].height).arc("wn").addTo(this),u+=Math.max(d.ARC_RADIUS,a.height+a.down+d.VERTICAL_SEPARATION+(o==r?0:this.items[o+1].up))}return this},r(w,u),w.prototype.needsSpace=!0,w.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i+this.height).h(n[1]).addTo(this),c(t+=n[0],i).right(d.ARC_RADIUS).addTo(this),this.item.format(t+d.ARC_RADIUS,i,this.width-2*d.ARC_RADIUS).addTo(this),c(t+this.width-d.ARC_RADIUS,i+this.height).right(d.ARC_RADIUS).addTo(this);var r=Math.max(2*d.ARC_RADIUS,this.item.height+this.item.down+d.VERTICAL_SEPARATION+this.rep.up);return c(t+d.ARC_RADIUS,i).arc("nw").down(r-2*d.ARC_RADIUS).arc("ws").addTo(this),this.rep.format(t+d.ARC_RADIUS,i+r,this.width-2*d.ARC_RADIUS).addTo(this),c(t+this.width-d.ARC_RADIUS,i+r+this.rep.height).arc("se").up(r-2*d.ARC_RADIUS+this.rep.height-this.item.height).arc("en").addTo(this),this},r(A,u),A.prototype.format=function(t,i){return!1===this.simpleType?this.attrs.d="M "+t+" "+(i-10)+" v 20 m 0 -10 h 20.5":this.attrs.d="M "+t+" "+(i-10)+" v 20 m 10 -20 v 20 m -10 -10 h 20.5",this},r(R,u),R.prototype.format=function(t,i){return!1===this.simpleType?this.attrs.d="M "+t+" "+i+" h 20 m 0 -10 v 20":this.attrs.d="M "+t+" "+i+" h 20 m -10 -10 v 20 m 10 -20 v 20",this},r(y,u),y.prototype.needsSpace=!0,y.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i).h(n[1]).addTo(this),u("rect",{x:t+=n[0],y:i-11,width:this.width,height:this.up+this.down,rx:10,ry:10}).addTo(this);var r=u("text",{x:t+this.width/2,y:i+4,occurrenceIdx:this.occurrenceIdx,topRuleName:this.topRuleName,dslRuleName:this.dslRuleName,tokenName:this.tokenName,label:this.label},this.text),h=u("title",{},this.title);return this.href?u("a",{"xlink:href":this.href},[r]).addTo(this):(r.addTo(this),void 0!==this.title&&h.addTo(this)),this},r(S,u),S.prototype.needsSpace=!0,S.prototype.format=function(t,i,e){var n=s(e,this.width);c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i).h(n[1]).addTo(this),u("rect",{x:t+=n[0],y:i-11,width:this.width,height:this.up+this.down}).addTo(this);var r=u("text",{x:t+this.width/2,y:i+4,occurrenceIdx:this.occurrenceIdx,topRuleName:this.topRuleName,ruleName:this.ruleName},this.text);return this.href?u("a",{"xlink:href":this.href},[r]).addTo(this):r.addTo(this),this},r(T,u),T.prototype.needsSpace=!0,T.prototype.format=function(t,i,e){var n=s(e,this.width);return c(t,i).h(n[0]).addTo(this),c(t+n[0]+this.width,i+this.height).h(n[1]).addTo(this),u("text",{x:(t+=n[0])+this.width/2,y:i+5,class:"comment"},this.text).addTo(this),this},r(v,u),v.prototype.format=function(t,i,e){return c(t,i).right(e).addTo(this),this},I={},void 0===(n=function(){return I}.apply(i,[]))||(t.exports=n);var E=[d,function(){var t=new d([].slice.call(arguments)),i=t.items;return i.shift(),i.pop(),i.unshift(new A(!1)),i.push(new R(!1)),t.items=i,t},p,m,l,g,w,function(t,i,e){return g(w(t,i),e)},y,S,T,v];["Diagram","ComplexDiagram","Sequence","Stack","Choice","Optional","OneOrMore","ZeroOrMore","Terminal","NonTerminal","Comment","Skip"].forEach((function(t,i){I[t]=E[i]}))}).call(this,{VERTICAL_SEPARATION:8,ARC_RADIUS:10,DIAGRAM_CLASS:"railroad-diagram",STROKE_ODD_PIXEL_LENGTH:!0,INTERNAL_ALIGNMENT:"center"})},305:function(t,i,e){"use strict";e(284)}}]); \ No newline at end of file diff --git a/assets/js/20.6fbe829b.js b/assets/js/20.6cd8ceff.js similarity index 97% rename from assets/js/20.6fbe829b.js rename to assets/js/20.6cd8ceff.js index 5d2cfdb10..cf3f2fbdb 100644 --- a/assets/js/20.6fbe829b.js +++ b/assets/js/20.6cd8ceff.js @@ -675,10 +675,10 @@ * Public License instead of this License. But first, please read * . * - * Version: 2.6.2 - * Release date: 15/02/2024 (built at 15/02/2024 11:09:54) + * Version: 2.7.0 + * Release date: 10/04/2024 (built at 10/04/2024 09:34:42) */ -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&&Object.prototype.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; +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; /** * @license * Copyright (c) 2024 Handsoncode. All rights reserved. @@ -688,7 +688,7 @@ class E extends l.HyperFormula{}E.HyperFormula=l.HyperFormula,E.ErrorType=o.Erro * @license * Copyright (c) 2024 Handsoncode. All rights reserved. */ -class a{constructor(e,t,r=!1){this.width=e,this.height=t,this.isRef=r}static error(){return new a(1,1,!0)}static scalar(){return new a(1,1,!1)}isScalar(){return 1===this.width&&1===this.height||this.isRef}}t.ArraySize=a,t.ArraySizePredictor=class{constructor(e,t){this.config=e,this.functionRegistry=t}checkArraySize(e,t){return this.checkArraySizeForAst(e,{formulaAddress:t,arraysFlag:this.config.useArrayArithmetic})}checkArraySizeForAst(e,t){switch(e.type){case i.AstNodeType.FUNCTION_CALL:return this.checkArraySizeForFunction(e,t);case i.AstNodeType.COLUMN_RANGE:case i.AstNodeType.ROW_RANGE:case i.AstNodeType.CELL_RANGE:{const r=n.AbsoluteCellRange.fromAstOrUndef(e,t.formulaAddress);return void 0===r?a.error():new a(r.width(),r.height(),!0)}case i.AstNodeType.ARRAY:{const r=[],n=[];for(const o of e.args){const e=o.map(e=>this.checkArraySizeForAst(e,t)),s=Math.min(...e.map(e=>e.height)),i=e.reduce((e,t)=>e+t.width,0);r.push(s),n.push(i)}const o=r.reduce((e,t)=>e+t,0),s=Math.min(...n);return new a(s,o)}case i.AstNodeType.STRING:case i.AstNodeType.NUMBER:return a.scalar();case i.AstNodeType.CELL_REFERENCE:return new a(1,1,!0);case i.AstNodeType.DIV_OP:case i.AstNodeType.CONCATENATE_OP:case i.AstNodeType.EQUALS_OP:case i.AstNodeType.GREATER_THAN_OP:case i.AstNodeType.GREATER_THAN_OR_EQUAL_OP:case i.AstNodeType.LESS_THAN_OP:case i.AstNodeType.LESS_THAN_OR_EQUAL_OP:case i.AstNodeType.MINUS_OP:case i.AstNodeType.NOT_EQUAL_OP:case i.AstNodeType.PLUS_OP:case i.AstNodeType.POWER_OP:case i.AstNodeType.TIMES_OP:{const r=this.checkArraySizeForAst(e.left,t),n=this.checkArraySizeForAst(e.right,t);return!t.arraysFlag&&(r.height>1||r.width>1||n.height>1||n.width>1)?a.error():(o=r,s=n,new a(Math.max(o.width,s.width),Math.max(o.height,s.height)))}case i.AstNodeType.MINUS_UNARY_OP:case i.AstNodeType.PLUS_UNARY_OP:case i.AstNodeType.PERCENT_OP:{const n=this.checkArraySizeForAst(e.value,t);return!t.arraysFlag&&(n.height>1||n.width>1)?a.error():new a((r=n).width,r.height)}case i.AstNodeType.PARENTHESIS:return this.checkArraySizeForAst(e.expression,t);case i.AstNodeType.EMPTY:default:return a.error()}var r,o,s}checkArraySizeForFunction(e,t){const r=this.functionRegistry.getArraySizeFunction(e.procedureName);if(void 0!==r)return r(e,t);const n=this.functionRegistry.getMetadata(e.procedureName);if(void 0===n||n.expandRanges||!t.arraysFlag||n.vectorizationForbidden||void 0===n.parameters)return new a(1,1);const i=e.args.map(e=>{var r;return this.checkArraySizeForAst(e,new o.InterpreterState(t.formulaAddress,t.arraysFlag||null!==(r=null==n?void 0:n.arrayFunction)&&void 0!==r&&r))}),u=[...n.parameters];if(void 0!==n.repeatLastArgs&&u.length0&&n[0]<4?1:+(n[0]+n[1])),!o&&i&&(!(n=i.match(/Edge\/(\d+)/))||n[1]>=74)&&(n=i.match(/Chrome\/(\d+)/))&&(o=+n[1]),e.exports=o},function(e,t,r){"use strict";e.exports="undefined"!=typeof navigator&&String(navigator.userAgent)||""},function(e,t,r){"use strict";var n=r(31),o=r(18);e.exports=function(e,t){var r=e[t];return o(r)?void 0:n(r)}},function(e,t,r){"use strict";var n=r(22),o=r(32),s=TypeError;e.exports=function(e){if(n(e))return e;throw new s(o(e)+" is not a function")}},function(e,t,r){"use strict";var n=String;e.exports=function(e){try{return n(e)}catch(e){return"Object"}}},function(e,t,r){"use strict";var n=r(9),o=r(22),s=r(21),i=TypeError;e.exports=function(e,t){var r,a;if("string"===t&&o(r=e.toString)&&!s(a=n(r,e)))return a;if(o(r=e.valueOf)&&!s(a=n(r,e)))return a;if("string"!==t&&o(r=e.toString)&&!s(a=n(r,e)))return a;throw new i("Can't convert object to primitive value")}},function(e,t,r){"use strict";var n=r(4),o=r(35),s=r(39),i=r(41),a=r(27),u=r(26),c=n.Symbol,l=o("wks"),h=u?c.for||c:c&&c.withoutSetter||i;e.exports=function(e){return s(l,e)||(l[e]=a&&s(c,e)?c[e]:h("Symbol."+e)),l[e]}},function(e,t,r){"use strict";var n=r(36),o=r(37);(e.exports=function(e,t){return o[e]||(o[e]=void 0!==t?t:{})})("versions",[]).push({version:"3.35.1",mode:n?"pure":"global",copyright:"© 2014-2024 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.35.1/LICENSE",source:"https://github.com/zloirock/core-js"})},function(e,t,r){"use strict";e.exports=!1},function(e,t,r){"use strict";var n=r(4),o=r(38),s=n["__core-js_shared__"]||o("__core-js_shared__",{});e.exports=s},function(e,t,r){"use strict";var n=r(4),o=Object.defineProperty;e.exports=function(e,t){try{o(n,e,{value:t,configurable:!0,writable:!0})}catch(r){n[e]=t}return t}},function(e,t,r){"use strict";var n=r(15),o=r(40),s=n({}.hasOwnProperty);e.exports=Object.hasOwn||function(e,t){return s(o(e),t)}},function(e,t,r){"use strict";var n=r(17),o=Object;e.exports=function(e){return o(n(e))}},function(e,t,r){"use strict";var n=r(15),o=0,s=Math.random(),i=n(1..toString);e.exports=function(e){return"Symbol("+(void 0===e?"":e)+")_"+i(++o+s,36)}},function(e,t,r){"use strict";var n=r(7),o=r(8),s=r(43);e.exports=!n&&!o((function(){return 7!==Object.defineProperty(s("div"),"a",{get:function(){return 7}}).a}))},function(e,t,r){"use strict";var n=r(4),o=r(21),s=n.document,i=o(s)&&o(s.createElement);e.exports=function(e){return i?s.createElement(e):{}}},function(e,t,r){"use strict";var n=r(7),o=r(45),s=r(12);e.exports=n?function(e,t,r){return o.f(e,t,s(1,r))}:function(e,t,r){return e[t]=r,e}},function(e,t,r){"use strict";var n=r(7),o=r(42),s=r(46),i=r(47),a=r(19),u=TypeError,c=Object.defineProperty,l=Object.getOwnPropertyDescriptor;t.f=n?s?function(e,t,r){if(i(e),t=a(t),i(r),"function"==typeof e&&"prototype"===t&&"value"in r&&"writable"in r&&!r.writable){var n=l(e,t);n&&n.writable&&(e[t]=r.value,r={configurable:"configurable"in r?r.configurable:n.configurable,enumerable:"enumerable"in r?r.enumerable:n.enumerable,writable:!1})}return c(e,t,r)}:c:function(e,t,r){if(i(e),t=a(t),i(r),o)try{return c(e,t,r)}catch(e){}if("get"in r||"set"in r)throw new u("Accessors not supported");return"value"in r&&(e[t]=r.value),e}},function(e,t,r){"use strict";var n=r(7),o=r(8);e.exports=n&&o((function(){return 42!==Object.defineProperty((function(){}),"prototype",{value:42,writable:!1}).prototype}))},function(e,t,r){"use strict";var n=r(21),o=String,s=TypeError;e.exports=function(e){if(n(e))return e;throw new s(o(e)+" is not an object")}},function(e,t,r){"use strict";var n=r(22),o=r(45),s=r(49),i=r(38);e.exports=function(e,t,r,a){a||(a={});var u=a.enumerable,c=void 0!==a.name?a.name:t;if(n(r)&&s(r,c,a),a.global)u?e[t]=r:i(t,r);else{try{a.unsafe?e[t]&&(u=!0):delete e[t]}catch(e){}u?e[t]=r:o.f(e,t,{value:r,enumerable:!1,configurable:!a.nonConfigurable,writable:!a.nonWritable})}return e}},function(e,t,r){"use strict";var n=r(15),o=r(8),s=r(22),i=r(39),a=r(7),u=r(50).CONFIGURABLE,c=r(51),l=r(52),h=l.enforce,d=l.get,p=String,m=Object.defineProperty,g=n("".slice),f=n("".replace),E=n([].join),T=a&&!o((function(){return 8!==m((function(){}),"length",{value:8}).length})),y=String(String).split("String"),A=e.exports=function(e,t,r){"Symbol("===g(p(t),0,7)&&(t="["+f(p(t),/^Symbol\(([^)]*)\).*$/,"$1")+"]"),r&&r.getter&&(t="get "+t),r&&r.setter&&(t="set "+t),(!i(e,"name")||u&&e.name!==t)&&(a?m(e,"name",{value:t,configurable:!0}):e.name=t),T&&r&&i(r,"arity")&&e.length!==r.arity&&m(e,"length",{value:r.arity});try{r&&i(r,"constructor")&&r.constructor?a&&m(e,"prototype",{writable:!1}):e.prototype&&(e.prototype=void 0)}catch(e){}var n=h(e);return i(n,"source")||(n.source=E(y,"string"==typeof t?t:"")),e};Function.prototype.toString=A((function(){return s(this)&&d(this).source||c(this)}),"toString")},function(e,t,r){"use strict";var n=r(7),o=r(39),s=Function.prototype,i=n&&Object.getOwnPropertyDescriptor,a=o(s,"name"),u=a&&"something"===function(){}.name,c=a&&(!n||n&&i(s,"name").configurable);e.exports={EXISTS:a,PROPER:u,CONFIGURABLE:c}},function(e,t,r){"use strict";var n=r(15),o=r(22),s=r(37),i=n(Function.toString);o(s.inspectSource)||(s.inspectSource=function(e){return i(e)}),e.exports=s.inspectSource},function(e,t,r){"use strict";var n,o,s,i=r(53),a=r(4),u=r(21),c=r(44),l=r(39),h=r(37),d=r(54),p=r(55),m=a.TypeError,g=a.WeakMap;if(i||h.state){var f=h.state||(h.state=new g);f.get=f.get,f.has=f.has,f.set=f.set,n=function(e,t){if(f.has(e))throw new m("Object already initialized");return t.facade=e,f.set(e,t),t},o=function(e){return f.get(e)||{}},s=function(e){return f.has(e)}}else{var E=d("state");p[E]=!0,n=function(e,t){if(l(e,E))throw new m("Object already initialized");return t.facade=e,c(e,E,t),t},o=function(e){return l(e,E)?e[E]:{}},s=function(e){return l(e,E)}}e.exports={set:n,get:o,has:s,enforce:function(e){return s(e)?o(e):n(e,{})},getterFor:function(e){return function(t){var r;if(!u(t)||(r=o(t)).type!==e)throw new m("Incompatible receiver, "+e+" required");return r}}}},function(e,t,r){"use strict";var n=r(4),o=r(22),s=n.WeakMap;e.exports=o(s)&&/native code/.test(String(s))},function(e,t,r){"use strict";var n=r(35),o=r(41),s=n("keys");e.exports=function(e){return s[e]||(s[e]=o(e))}},function(e,t,r){"use strict";e.exports={}},function(e,t,r){"use strict";var n=r(39),o=r(57),s=r(6),i=r(45);e.exports=function(e,t,r){for(var a=o(t),u=i.f,c=s.f,l=0;lc;)o(n,r=t[c++])&&(~i(l,r)||u(l,r));return l}},function(e,t,r){"use strict";var n=r(13),o=r(61),s=r(64),i=function(e){return function(t,r,i){var a,u=n(t),c=s(u),l=o(i,c);if(e&&r!=r){for(;c>l;)if((a=u[l++])!=a)return!0}else for(;c>l;l++)if((e||l in u)&&u[l]===r)return e||l||0;return!e&&-1}};e.exports={includes:i(!0),indexOf:i(!1)}},function(e,t,r){"use strict";var n=r(62),o=Math.max,s=Math.min;e.exports=function(e,t){var r=n(e);return r<0?o(r+t,0):s(r,t)}},function(e,t,r){"use strict";var n=r(63);e.exports=function(e){var t=+e;return t!=t||0===t?0:n(t)}},function(e,t,r){"use strict";var n=Math.ceil,o=Math.floor;e.exports=Math.trunc||function(e){var t=+e;return(t>0?o:n)(t)}},function(e,t,r){"use strict";var n=r(65);e.exports=function(e){return n(e.length)}},function(e,t,r){"use strict";var n=r(62),o=Math.min;e.exports=function(e){var t=n(e);return t>0?o(t,9007199254740991):0}},function(e,t,r){"use strict";e.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(e,t,r){"use strict";t.f=Object.getOwnPropertySymbols},function(e,t,r){"use strict";var n=r(8),o=r(22),s=/#|\.prototype\./,i=function(e,t){var r=u[a(e)];return r===l||r!==c&&(o(t)?n(t):!!t)},a=i.normalize=function(e){return String(e).replace(s,".").toLowerCase()},u=i.data={},c=i.NATIVE="N",l=i.POLYFILL="P";e.exports=i},function(e,t,r){"use strict";var n=r(7),o=r(70),s=TypeError,i=Object.getOwnPropertyDescriptor,a=n&&!function(){if(void 0!==this)return!0;try{Object.defineProperty([],"length",{writable:!1}).length=1}catch(e){return e instanceof TypeError}}();e.exports=a?function(e,t){if(o(e)&&!i(e,"length").writable)throw new s("Cannot set read only .length");return e.length=t}:function(e,t){return e.length=t}},function(e,t,r){"use strict";var n=r(16);e.exports=Array.isArray||function(e){return"Array"===n(e)}},function(e,t,r){"use strict";var n=TypeError;e.exports=function(e){if(e>9007199254740991)throw n("Maximum allowed index exceeded");return e}},function(e,t,r){"use strict";t.__esModule=!0,t.WRONG_RANGE_SIZE=t.AbsoluteRowRange=t.AbsoluteColumnRange=t.AbsoluteCellRange=void 0,t.isSimpleCellRange=function(e){return!(!e||"object"!=typeof e&&"function"!=typeof e)&&"start"in e&&(0,n.isSimpleCellAddress)(e.start)&&"end"in e&&(0,n.isSimpleCellAddress)(e.end)},t.simpleCellRange=void 0,r(2);var n=r(73),o=r(147),s=r(77),i=r(141); +class a{constructor(e,t,r=!1){this.width=e,this.height=t,this.isRef=r}static error(){return new a(1,1,!0)}static scalar(){return new a(1,1,!1)}isScalar(){return 1===this.width&&1===this.height||this.isRef}}t.ArraySize=a,t.ArraySizePredictor=class{constructor(e,t){this.config=e,this.functionRegistry=t}checkArraySize(e,t){return this.checkArraySizeForAst(e,{formulaAddress:t,arraysFlag:this.config.useArrayArithmetic})}checkArraySizeForAst(e,t){switch(e.type){case i.AstNodeType.FUNCTION_CALL:return this.checkArraySizeForFunction(e,t);case i.AstNodeType.COLUMN_RANGE:case i.AstNodeType.ROW_RANGE:case i.AstNodeType.CELL_RANGE:{const r=n.AbsoluteCellRange.fromAstOrUndef(e,t.formulaAddress);return void 0===r?a.error():new a(r.width(),r.height(),!0)}case i.AstNodeType.ARRAY:{const r=[],n=[];for(const o of e.args){const e=o.map(e=>this.checkArraySizeForAst(e,t)),s=Math.min(...e.map(e=>e.height)),i=e.reduce((e,t)=>e+t.width,0);r.push(s),n.push(i)}const o=r.reduce((e,t)=>e+t,0),s=Math.min(...n);return new a(s,o)}case i.AstNodeType.STRING:case i.AstNodeType.NUMBER:return a.scalar();case i.AstNodeType.CELL_REFERENCE:return new a(1,1,!0);case i.AstNodeType.DIV_OP:case i.AstNodeType.CONCATENATE_OP:case i.AstNodeType.EQUALS_OP:case i.AstNodeType.GREATER_THAN_OP:case i.AstNodeType.GREATER_THAN_OR_EQUAL_OP:case i.AstNodeType.LESS_THAN_OP:case i.AstNodeType.LESS_THAN_OR_EQUAL_OP:case i.AstNodeType.MINUS_OP:case i.AstNodeType.NOT_EQUAL_OP:case i.AstNodeType.PLUS_OP:case i.AstNodeType.POWER_OP:case i.AstNodeType.TIMES_OP:{const r=this.checkArraySizeForAst(e.left,t),n=this.checkArraySizeForAst(e.right,t);return!t.arraysFlag&&(r.height>1||r.width>1||n.height>1||n.width>1)?a.error():(o=r,s=n,new a(Math.max(o.width,s.width),Math.max(o.height,s.height)))}case i.AstNodeType.MINUS_UNARY_OP:case i.AstNodeType.PLUS_UNARY_OP:case i.AstNodeType.PERCENT_OP:{const n=this.checkArraySizeForAst(e.value,t);return!t.arraysFlag&&(n.height>1||n.width>1)?a.error():new a((r=n).width,r.height)}case i.AstNodeType.PARENTHESIS:return this.checkArraySizeForAst(e.expression,t);case i.AstNodeType.EMPTY:default:return a.error()}var r,o,s}checkArraySizeForFunction(e,t){const r=this.functionRegistry.getArraySizeFunction(e.procedureName);if(void 0!==r)return r(e,t);const n=this.functionRegistry.getMetadata(e.procedureName);if(void 0===n||n.expandRanges||!t.arraysFlag||n.vectorizationForbidden||void 0===n.parameters)return new a(1,1);const i=e.args.map(e=>{var r;return this.checkArraySizeForAst(e,new o.InterpreterState(t.formulaAddress,t.arraysFlag||null!==(r=null==n?void 0:n.arrayFunction)&&void 0!==r&&r))}),u=[...n.parameters];if(void 0!==n.repeatLastArgs&&u.length0&&n[0]<4?1:+(n[0]+n[1])),!o&&i&&(!(n=i.match(/Edge\/(\d+)/))||n[1]>=74)&&(n=i.match(/Chrome\/(\d+)/))&&(o=+n[1]),e.exports=o},function(e,t,r){"use strict";e.exports="undefined"!=typeof navigator&&String(navigator.userAgent)||""},function(e,t,r){"use strict";var n=r(31),o=r(18);e.exports=function(e,t){var r=e[t];return o(r)?void 0:n(r)}},function(e,t,r){"use strict";var n=r(22),o=r(32),s=TypeError;e.exports=function(e){if(n(e))return e;throw new s(o(e)+" is not a function")}},function(e,t,r){"use strict";var n=String;e.exports=function(e){try{return n(e)}catch(e){return"Object"}}},function(e,t,r){"use strict";var n=r(9),o=r(22),s=r(21),i=TypeError;e.exports=function(e,t){var r,a;if("string"===t&&o(r=e.toString)&&!s(a=n(r,e)))return a;if(o(r=e.valueOf)&&!s(a=n(r,e)))return a;if("string"!==t&&o(r=e.toString)&&!s(a=n(r,e)))return a;throw new i("Can't convert object to primitive value")}},function(e,t,r){"use strict";var n=r(4),o=r(35),s=r(39),i=r(41),a=r(27),u=r(26),c=n.Symbol,l=o("wks"),h=u?c.for||c:c&&c.withoutSetter||i;e.exports=function(e){return s(l,e)||(l[e]=a&&s(c,e)?c[e]:h("Symbol."+e)),l[e]}},function(e,t,r){"use strict";var n=r(36);e.exports=function(e,t){return n[e]||(n[e]=t||{})}},function(e,t,r){"use strict";var n=r(37),o=r(4),s=r(38),i=e.exports=o["__core-js_shared__"]||s("__core-js_shared__",{});(i.versions||(i.versions=[])).push({version:"3.36.1",mode:n?"pure":"global",copyright:"© 2014-2024 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.36.1/LICENSE",source:"https://github.com/zloirock/core-js"})},function(e,t,r){"use strict";e.exports=!1},function(e,t,r){"use strict";var n=r(4),o=Object.defineProperty;e.exports=function(e,t){try{o(n,e,{value:t,configurable:!0,writable:!0})}catch(r){n[e]=t}return t}},function(e,t,r){"use strict";var n=r(15),o=r(40),s=n({}.hasOwnProperty);e.exports=Object.hasOwn||function(e,t){return s(o(e),t)}},function(e,t,r){"use strict";var n=r(17),o=Object;e.exports=function(e){return o(n(e))}},function(e,t,r){"use strict";var n=r(15),o=0,s=Math.random(),i=n(1..toString);e.exports=function(e){return"Symbol("+(void 0===e?"":e)+")_"+i(++o+s,36)}},function(e,t,r){"use strict";var n=r(7),o=r(8),s=r(43);e.exports=!n&&!o((function(){return 7!==Object.defineProperty(s("div"),"a",{get:function(){return 7}}).a}))},function(e,t,r){"use strict";var n=r(4),o=r(21),s=n.document,i=o(s)&&o(s.createElement);e.exports=function(e){return i?s.createElement(e):{}}},function(e,t,r){"use strict";var n=r(7),o=r(45),s=r(12);e.exports=n?function(e,t,r){return o.f(e,t,s(1,r))}:function(e,t,r){return e[t]=r,e}},function(e,t,r){"use strict";var n=r(7),o=r(42),s=r(46),i=r(47),a=r(19),u=TypeError,c=Object.defineProperty,l=Object.getOwnPropertyDescriptor;t.f=n?s?function(e,t,r){if(i(e),t=a(t),i(r),"function"==typeof e&&"prototype"===t&&"value"in r&&"writable"in r&&!r.writable){var n=l(e,t);n&&n.writable&&(e[t]=r.value,r={configurable:"configurable"in r?r.configurable:n.configurable,enumerable:"enumerable"in r?r.enumerable:n.enumerable,writable:!1})}return c(e,t,r)}:c:function(e,t,r){if(i(e),t=a(t),i(r),o)try{return c(e,t,r)}catch(e){}if("get"in r||"set"in r)throw new u("Accessors not supported");return"value"in r&&(e[t]=r.value),e}},function(e,t,r){"use strict";var n=r(7),o=r(8);e.exports=n&&o((function(){return 42!==Object.defineProperty((function(){}),"prototype",{value:42,writable:!1}).prototype}))},function(e,t,r){"use strict";var n=r(21),o=String,s=TypeError;e.exports=function(e){if(n(e))return e;throw new s(o(e)+" is not an object")}},function(e,t,r){"use strict";var n=r(22),o=r(45),s=r(49),i=r(38);e.exports=function(e,t,r,a){a||(a={});var u=a.enumerable,c=void 0!==a.name?a.name:t;if(n(r)&&s(r,c,a),a.global)u?e[t]=r:i(t,r);else{try{a.unsafe?e[t]&&(u=!0):delete e[t]}catch(e){}u?e[t]=r:o.f(e,t,{value:r,enumerable:!1,configurable:!a.nonConfigurable,writable:!a.nonWritable})}return e}},function(e,t,r){"use strict";var n=r(15),o=r(8),s=r(22),i=r(39),a=r(7),u=r(50).CONFIGURABLE,c=r(51),l=r(52),h=l.enforce,d=l.get,p=String,m=Object.defineProperty,g=n("".slice),f=n("".replace),E=n([].join),T=a&&!o((function(){return 8!==m((function(){}),"length",{value:8}).length})),y=String(String).split("String"),A=e.exports=function(e,t,r){"Symbol("===g(p(t),0,7)&&(t="["+f(p(t),/^Symbol\(([^)]*)\).*$/,"$1")+"]"),r&&r.getter&&(t="get "+t),r&&r.setter&&(t="set "+t),(!i(e,"name")||u&&e.name!==t)&&(a?m(e,"name",{value:t,configurable:!0}):e.name=t),T&&r&&i(r,"arity")&&e.length!==r.arity&&m(e,"length",{value:r.arity});try{r&&i(r,"constructor")&&r.constructor?a&&m(e,"prototype",{writable:!1}):e.prototype&&(e.prototype=void 0)}catch(e){}var n=h(e);return i(n,"source")||(n.source=E(y,"string"==typeof t?t:"")),e};Function.prototype.toString=A((function(){return s(this)&&d(this).source||c(this)}),"toString")},function(e,t,r){"use strict";var n=r(7),o=r(39),s=Function.prototype,i=n&&Object.getOwnPropertyDescriptor,a=o(s,"name"),u=a&&"something"===function(){}.name,c=a&&(!n||n&&i(s,"name").configurable);e.exports={EXISTS:a,PROPER:u,CONFIGURABLE:c}},function(e,t,r){"use strict";var n=r(15),o=r(22),s=r(36),i=n(Function.toString);o(s.inspectSource)||(s.inspectSource=function(e){return i(e)}),e.exports=s.inspectSource},function(e,t,r){"use strict";var n,o,s,i=r(53),a=r(4),u=r(21),c=r(44),l=r(39),h=r(36),d=r(54),p=r(55),m=a.TypeError,g=a.WeakMap;if(i||h.state){var f=h.state||(h.state=new g);f.get=f.get,f.has=f.has,f.set=f.set,n=function(e,t){if(f.has(e))throw new m("Object already initialized");return t.facade=e,f.set(e,t),t},o=function(e){return f.get(e)||{}},s=function(e){return f.has(e)}}else{var E=d("state");p[E]=!0,n=function(e,t){if(l(e,E))throw new m("Object already initialized");return t.facade=e,c(e,E,t),t},o=function(e){return l(e,E)?e[E]:{}},s=function(e){return l(e,E)}}e.exports={set:n,get:o,has:s,enforce:function(e){return s(e)?o(e):n(e,{})},getterFor:function(e){return function(t){var r;if(!u(t)||(r=o(t)).type!==e)throw new m("Incompatible receiver, "+e+" required");return r}}}},function(e,t,r){"use strict";var n=r(4),o=r(22),s=n.WeakMap;e.exports=o(s)&&/native code/.test(String(s))},function(e,t,r){"use strict";var n=r(35),o=r(41),s=n("keys");e.exports=function(e){return s[e]||(s[e]=o(e))}},function(e,t,r){"use strict";e.exports={}},function(e,t,r){"use strict";var n=r(39),o=r(57),s=r(6),i=r(45);e.exports=function(e,t,r){for(var a=o(t),u=i.f,c=s.f,l=0;lc;)o(n,r=t[c++])&&(~i(l,r)||u(l,r));return l}},function(e,t,r){"use strict";var n=r(13),o=r(61),s=r(64),i=function(e){return function(t,r,i){var a=n(t),u=s(a);if(0===u)return!e&&-1;var c,l=o(i,u);if(e&&r!=r){for(;u>l;)if((c=a[l++])!=c)return!0}else for(;u>l;l++)if((e||l in a)&&a[l]===r)return e||l||0;return!e&&-1}};e.exports={includes:i(!0),indexOf:i(!1)}},function(e,t,r){"use strict";var n=r(62),o=Math.max,s=Math.min;e.exports=function(e,t){var r=n(e);return r<0?o(r+t,0):s(r,t)}},function(e,t,r){"use strict";var n=r(63);e.exports=function(e){var t=+e;return t!=t||0===t?0:n(t)}},function(e,t,r){"use strict";var n=Math.ceil,o=Math.floor;e.exports=Math.trunc||function(e){var t=+e;return(t>0?o:n)(t)}},function(e,t,r){"use strict";var n=r(65);e.exports=function(e){return n(e.length)}},function(e,t,r){"use strict";var n=r(62),o=Math.min;e.exports=function(e){var t=n(e);return t>0?o(t,9007199254740991):0}},function(e,t,r){"use strict";e.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(e,t,r){"use strict";t.f=Object.getOwnPropertySymbols},function(e,t,r){"use strict";var n=r(8),o=r(22),s=/#|\.prototype\./,i=function(e,t){var r=u[a(e)];return r===l||r!==c&&(o(t)?n(t):!!t)},a=i.normalize=function(e){return String(e).replace(s,".").toLowerCase()},u=i.data={},c=i.NATIVE="N",l=i.POLYFILL="P";e.exports=i},function(e,t,r){"use strict";var n=r(7),o=r(70),s=TypeError,i=Object.getOwnPropertyDescriptor,a=n&&!function(){if(void 0!==this)return!0;try{Object.defineProperty([],"length",{writable:!1}).length=1}catch(e){return e instanceof TypeError}}();e.exports=a?function(e,t){if(o(e)&&!i(e,"length").writable)throw new s("Cannot set read only .length");return e.length=t}:function(e,t){return e.length=t}},function(e,t,r){"use strict";var n=r(16);e.exports=Array.isArray||function(e){return"Array"===n(e)}},function(e,t,r){"use strict";var n=TypeError;e.exports=function(e){if(e>9007199254740991)throw n("Maximum allowed index exceeded");return e}},function(e,t,r){"use strict";t.__esModule=!0,t.WRONG_RANGE_SIZE=t.AbsoluteRowRange=t.AbsoluteColumnRange=t.AbsoluteCellRange=void 0,t.isSimpleCellRange=function(e){return!(!e||"object"!=typeof e&&"function"!=typeof e)&&"start"in e&&(0,n.isSimpleCellAddress)(e.start)&&"end"in e&&(0,n.isSimpleCellAddress)(e.end)},t.simpleCellRange=void 0,r(2);var n=r(73),o=r(147),s=r(77),i=r(141); /** * @license * Copyright (c) 2024 Handsoncode. All rights reserved. @@ -899,7 +899,7 @@ class{constructor(e,t,r){var n;this.value=t,this.address=r,this.type=e.type,this * @license * Copyright (c) 2024 Handsoncode. All rights reserved. */ -const h=new WeakMap;class d{constructor(e={},t=!0){const{accentSensitive:r,binarySearchThreshold:o,caseSensitive:i,caseFirst:a,chooseAddressMappingPolicy:u,currencySymbol:p,dateFormats:m,decimalSeparator:g,evaluateNullToZero:f,functionArgSeparator:E,functionPlugins:T,ignorePunctuation:y,leapYear1900:A,localeLang:R,language:N,ignoreWhiteSpace:S,licenseKey:C,matchWholeCell:v,arrayColumnSeparator:O,arrayRowSeparator:I,maxRows:M,maxColumns:b,nullYear:F,nullDate:w,parseDateTime:_,precisionEpsilon:L,precisionRounding:x,stringifyDateTime:P,stringifyDuration:U,smartRounding:V,timeFormats:D,thousandSeparator:B,useArrayArithmetic:k,useStats:G,undoLimit:j,useColumnIndex:W,useRegularExpressions:H,useWildcards:z}=e;t&&d.warnDeprecatedOptions(e),this.useArrayArithmetic=(0,n.configValueFromParam)(k,"boolean","useArrayArithmetic"),this.accentSensitive=(0,n.configValueFromParam)(r,"boolean","accentSensitive"),this.caseSensitive=(0,n.configValueFromParam)(i,"boolean","caseSensitive"),this.caseFirst=(0,n.configValueFromParam)(a,["upper","lower","false"],"caseFirst"),this.ignorePunctuation=(0,n.configValueFromParam)(y,"boolean","ignorePunctuation"),this.chooseAddressMappingPolicy=null!=u?u:d.defaultConfig.chooseAddressMappingPolicy,this.dateFormats=[...(0,n.configValueFromParamCheck)(m,Array.isArray,"array","dateFormats")],this.timeFormats=[...(0,n.configValueFromParamCheck)(D,Array.isArray,"array","timeFormats")],this.functionArgSeparator=(0,n.configValueFromParam)(E,"string","functionArgSeparator"),this.decimalSeparator=(0,n.configValueFromParam)(g,[".",","],"decimalSeparator"),this.language=(0,n.configValueFromParam)(N,"string","language"),this.ignoreWhiteSpace=(0,n.configValueFromParam)(S,["standard","any"],"ignoreWhiteSpace"),this.licenseKey=(0,n.configValueFromParam)(C,"string","licenseKey"),this.thousandSeparator=(0,n.configValueFromParam)(B,["",","," ","."],"thousandSeparator"),this.arrayColumnSeparator=(0,n.configValueFromParam)(O,[",",";"],"arrayColumnSeparator"),this.arrayRowSeparator=(0,n.configValueFromParam)(I,[";","|"],"arrayRowSeparator"),this.localeLang=(0,n.configValueFromParam)(R,"string","localeLang"),this.functionPlugins=[...null!=T?T:d.defaultConfig.functionPlugins],this.smartRounding=(0,n.configValueFromParam)(V,"boolean","smartRounding"),this.evaluateNullToZero=(0,n.configValueFromParam)(f,"boolean","evaluateNullToZero"),this.nullYear=(0,n.configValueFromParam)(F,"number","nullYear"),(0,n.validateNumberToBeAtLeast)(this.nullYear,"nullYear",0),(0,n.validateNumberToBeAtMost)(this.nullYear,"nullYear",100),this.precisionRounding=(0,n.configValueFromParam)(x,"number","precisionRounding"),(0,n.validateNumberToBeAtLeast)(this.precisionRounding,"precisionRounding",0),this.precisionEpsilon=(0,n.configValueFromParam)(L,"number","precisionEpsilon"),(0,n.validateNumberToBeAtLeast)(this.precisionEpsilon,"precisionEpsilon",0),this.useColumnIndex=(0,n.configValueFromParam)(W,"boolean","useColumnIndex"),this.useStats=(0,n.configValueFromParam)(G,"boolean","useStats"),this.binarySearchThreshold=null!=o?o:d.defaultConfig.binarySearchThreshold,this.parseDateTime=(0,n.configValueFromParam)(_,"function","parseDateTime"),this.stringifyDateTime=(0,n.configValueFromParam)(P,"function","stringifyDateTime"),this.stringifyDuration=(0,n.configValueFromParam)(U,"function","stringifyDuration"),this.translationPackage=l.HyperFormula.getLanguage(this.language),this.errorMapping=this.translationPackage.buildErrorMapping(),this.nullDate=(0,n.configValueFromParamCheck)(w,s.instanceOfSimpleDate,"IDate","nullDate"),this.leapYear1900=(0,n.configValueFromParam)(A,"boolean","leapYear1900"),this.undoLimit=(0,n.configValueFromParam)(j,"number","undoLimit"),this.useRegularExpressions=(0,n.configValueFromParam)(H,"boolean","useRegularExpressions"),this.useWildcards=(0,n.configValueFromParam)(z,"boolean","useWildcards"),this.matchWholeCell=(0,n.configValueFromParam)(v,"boolean","matchWholeCell"),(0,n.validateNumberToBeAtLeast)(this.undoLimit,"undoLimit",0),this.maxRows=(0,n.configValueFromParam)(M,"number","maxRows"),(0,n.validateNumberToBeAtLeast)(this.maxRows,"maxRows",1),this.maxColumns=(0,n.configValueFromParam)(b,"number","maxColumns"),this.currencySymbol=this.setupCurrencySymbol(p),(0,n.validateNumberToBeAtLeast)(this.maxColumns,"maxColumns",1),h.set(this,{licenseKeyValidityState:(0,c.checkLicenseKeyValidity)(this.licenseKey)}),(0,n.configCheckIfParametersNotInConflict)({value:this.decimalSeparator,name:"decimalSeparator"},{value:this.functionArgSeparator,name:"functionArgSeparator"},{value:this.thousandSeparator,name:"thousandSeparator"}),(0,n.configCheckIfParametersNotInConflict)({value:this.arrayRowSeparator,name:"arrayRowSeparator"},{value:this.arrayColumnSeparator,name:"arrayColumnSeparator"})}setupCurrencySymbol(e){const t=[...(0,n.configValueFromParamCheck)(e,Array.isArray,"array","currencySymbol")];return t.forEach(e=>{if("string"!=typeof e)throw new a.ExpectedValueOfTypeError("string[]","currencySymbol");if(""===e)throw new a.ConfigValueEmpty("currencySymbol")}),t}get licenseKeyValidityState(){return h.get(this).licenseKeyValidityState}getConfig(){return p(this)}mergeConfig(e){const t=Object.assign({},this.getConfig(),e);return d.warnDeprecatedOptions(e),new d(t,!1)}static warnDeprecatedOptions(e){d.warnDeprecatedIfUsed(e.binarySearchThreshold,"binarySearchThreshold","1.1")}static warnDeprecatedIfUsed(e,t,r,n){void 0!==e&&(void 0===n?console.warn(`${t} option is deprecated since ${r}`):console.warn(`${t} option is deprecated since ${r}, please use ${n}`))}}function p(e){var t;const r={};for(const n in d.defaultConfig){const o=null!==(t=e[n])&&void 0!==t?t:d.defaultConfig[n];Array.isArray(o)?r[n]=[...o]:r[n]=o}return r}t.Config=d,d.defaultConfig={accentSensitive:!1,binarySearchThreshold:20,currencySymbol:["$"],caseSensitive:!1,caseFirst:"lower",chooseAddressMappingPolicy:new i.AlwaysDense,dateFormats:["DD/MM/YYYY","DD/MM/YY"],decimalSeparator:".",evaluateNullToZero:!1,functionArgSeparator:",",functionPlugins:[],ignorePunctuation:!1,language:"enGB",ignoreWhiteSpace:"standard",licenseKey:"",leapYear1900:!1,localeLang:"en",matchWholeCell:!0,arrayColumnSeparator:",",arrayRowSeparator:";",maxRows:4e4,maxColumns:18278,nullYear:30,nullDate:{year:1899,month:12,day:30},parseDateTime:o.defaultParseToDateTime,precisionEpsilon:1e-13,precisionRounding:14,smartRounding:!0,stringifyDateTime:u.defaultStringifyDateTime,stringifyDuration:u.defaultStringifyDuration,timeFormats:["hh:mm","hh:mm:ss.sss"],thousandSeparator:"",undoLimit:20,useRegularExpressions:!1,useWildcards:!0,useColumnIndex:!1,useStats:!1,useArrayArithmetic:!1}},function(e,t,r){"use strict";t.__esModule=!0,t.configCheckIfParametersNotInConflict=function(...e){const t=new Map;e.forEach(e=>{const r=t.get(e.value)||[];r.push(e.name),t.set(e.value,r)});const r=[];for(const e of t.values())e.length>1&&r.push(e);if(r.length>0){r.forEach(e=>e.sort());const e=r.map(e=>`[${e}]`).join("; ");throw new Error("Config initialization failed. Parameters in conflict: "+e)}},t.configValueFromParam= +const h=new WeakMap;class d{constructor(e={},t=!0){const{accentSensitive:r,binarySearchThreshold:o,caseSensitive:i,caseFirst:a,chooseAddressMappingPolicy:u,context:p,currencySymbol:m,dateFormats:g,decimalSeparator:f,evaluateNullToZero:E,functionArgSeparator:T,functionPlugins:y,ignorePunctuation:A,leapYear1900:R,localeLang:N,language:S,ignoreWhiteSpace:C,licenseKey:v,matchWholeCell:O,arrayColumnSeparator:I,arrayRowSeparator:M,maxRows:b,maxColumns:F,nullYear:w,nullDate:_,parseDateTime:L,precisionEpsilon:x,precisionRounding:P,stringifyDateTime:U,stringifyDuration:V,smartRounding:D,timeFormats:B,thousandSeparator:k,useArrayArithmetic:G,useStats:j,undoLimit:W,useColumnIndex:H,useRegularExpressions:z,useWildcards:Y}=e;t&&d.warnDeprecatedOptions(e),this.useArrayArithmetic=(0,n.configValueFromParam)(G,"boolean","useArrayArithmetic"),this.accentSensitive=(0,n.configValueFromParam)(r,"boolean","accentSensitive"),this.caseSensitive=(0,n.configValueFromParam)(i,"boolean","caseSensitive"),this.caseFirst=(0,n.configValueFromParam)(a,["upper","lower","false"],"caseFirst"),this.ignorePunctuation=(0,n.configValueFromParam)(A,"boolean","ignorePunctuation"),this.chooseAddressMappingPolicy=null!=u?u:d.defaultConfig.chooseAddressMappingPolicy,this.dateFormats=[...(0,n.configValueFromParamCheck)(g,Array.isArray,"array","dateFormats")],this.timeFormats=[...(0,n.configValueFromParamCheck)(B,Array.isArray,"array","timeFormats")],this.functionArgSeparator=(0,n.configValueFromParam)(T,"string","functionArgSeparator"),this.decimalSeparator=(0,n.configValueFromParam)(f,[".",","],"decimalSeparator"),this.language=(0,n.configValueFromParam)(S,"string","language"),this.ignoreWhiteSpace=(0,n.configValueFromParam)(C,["standard","any"],"ignoreWhiteSpace"),this.licenseKey=(0,n.configValueFromParam)(v,"string","licenseKey"),this.thousandSeparator=(0,n.configValueFromParam)(k,["",","," ","."],"thousandSeparator"),this.arrayColumnSeparator=(0,n.configValueFromParam)(I,[",",";"],"arrayColumnSeparator"),this.arrayRowSeparator=(0,n.configValueFromParam)(M,[";","|"],"arrayRowSeparator"),this.localeLang=(0,n.configValueFromParam)(N,"string","localeLang"),this.functionPlugins=[...null!=y?y:d.defaultConfig.functionPlugins],this.smartRounding=(0,n.configValueFromParam)(D,"boolean","smartRounding"),this.evaluateNullToZero=(0,n.configValueFromParam)(E,"boolean","evaluateNullToZero"),this.nullYear=(0,n.configValueFromParam)(w,"number","nullYear"),(0,n.validateNumberToBeAtLeast)(this.nullYear,"nullYear",0),(0,n.validateNumberToBeAtMost)(this.nullYear,"nullYear",100),this.precisionRounding=(0,n.configValueFromParam)(P,"number","precisionRounding"),(0,n.validateNumberToBeAtLeast)(this.precisionRounding,"precisionRounding",0),this.precisionEpsilon=(0,n.configValueFromParam)(x,"number","precisionEpsilon"),(0,n.validateNumberToBeAtLeast)(this.precisionEpsilon,"precisionEpsilon",0),this.useColumnIndex=(0,n.configValueFromParam)(H,"boolean","useColumnIndex"),this.useStats=(0,n.configValueFromParam)(j,"boolean","useStats"),this.binarySearchThreshold=null!=o?o:d.defaultConfig.binarySearchThreshold,this.parseDateTime=(0,n.configValueFromParam)(L,"function","parseDateTime"),this.stringifyDateTime=(0,n.configValueFromParam)(U,"function","stringifyDateTime"),this.stringifyDuration=(0,n.configValueFromParam)(V,"function","stringifyDuration"),this.translationPackage=l.HyperFormula.getLanguage(this.language),this.errorMapping=this.translationPackage.buildErrorMapping(),this.nullDate=(0,n.configValueFromParamCheck)(_,s.instanceOfSimpleDate,"IDate","nullDate"),this.leapYear1900=(0,n.configValueFromParam)(R,"boolean","leapYear1900"),this.undoLimit=(0,n.configValueFromParam)(W,"number","undoLimit"),this.useRegularExpressions=(0,n.configValueFromParam)(z,"boolean","useRegularExpressions"),this.useWildcards=(0,n.configValueFromParam)(Y,"boolean","useWildcards"),this.matchWholeCell=(0,n.configValueFromParam)(O,"boolean","matchWholeCell"),(0,n.validateNumberToBeAtLeast)(this.undoLimit,"undoLimit",0),this.maxRows=(0,n.configValueFromParam)(b,"number","maxRows"),(0,n.validateNumberToBeAtLeast)(this.maxRows,"maxRows",1),this.maxColumns=(0,n.configValueFromParam)(F,"number","maxColumns"),this.currencySymbol=this.setupCurrencySymbol(m),(0,n.validateNumberToBeAtLeast)(this.maxColumns,"maxColumns",1),this.context=p,h.set(this,{licenseKeyValidityState:(0,c.checkLicenseKeyValidity)(this.licenseKey)}),(0,n.configCheckIfParametersNotInConflict)({value:this.decimalSeparator,name:"decimalSeparator"},{value:this.functionArgSeparator,name:"functionArgSeparator"},{value:this.thousandSeparator,name:"thousandSeparator"}),(0,n.configCheckIfParametersNotInConflict)({value:this.arrayRowSeparator,name:"arrayRowSeparator"},{value:this.arrayColumnSeparator,name:"arrayColumnSeparator"})}setupCurrencySymbol(e){const t=[...(0,n.configValueFromParamCheck)(e,Array.isArray,"array","currencySymbol")];return t.forEach(e=>{if("string"!=typeof e)throw new a.ExpectedValueOfTypeError("string[]","currencySymbol");if(""===e)throw new a.ConfigValueEmpty("currencySymbol")}),t}get licenseKeyValidityState(){return h.get(this).licenseKeyValidityState}getConfig(){return p(this)}mergeConfig(e){const t=Object.assign({},this.getConfig(),e);return d.warnDeprecatedOptions(e),new d(t,!1)}static warnDeprecatedOptions(e){d.warnDeprecatedIfUsed(e.binarySearchThreshold,"binarySearchThreshold","1.1")}static warnDeprecatedIfUsed(e,t,r,n){void 0!==e&&(void 0===n?console.warn(`${t} option is deprecated since ${r}`):console.warn(`${t} option is deprecated since ${r}, please use ${n}`))}}function p(e){var t;const r={};for(const n in d.defaultConfig){const o=null!==(t=e[n])&&void 0!==t?t:d.defaultConfig[n];Array.isArray(o)?r[n]=[...o]:r[n]=o}return r}t.Config=d,d.defaultConfig={accentSensitive:!1,binarySearchThreshold:20,currencySymbol:["$"],caseSensitive:!1,caseFirst:"lower",context:void 0,chooseAddressMappingPolicy:new i.AlwaysDense,dateFormats:["DD/MM/YYYY","DD/MM/YY"],decimalSeparator:".",evaluateNullToZero:!1,functionArgSeparator:",",functionPlugins:[],ignorePunctuation:!1,language:"enGB",ignoreWhiteSpace:"standard",licenseKey:"",leapYear1900:!1,localeLang:"en",matchWholeCell:!0,arrayColumnSeparator:",",arrayRowSeparator:";",maxRows:4e4,maxColumns:18278,nullYear:30,nullDate:{year:1899,month:12,day:30},parseDateTime:o.defaultParseToDateTime,precisionEpsilon:1e-13,precisionRounding:14,smartRounding:!0,stringifyDateTime:u.defaultStringifyDateTime,stringifyDuration:u.defaultStringifyDuration,timeFormats:["hh:mm","hh:mm:ss.sss"],thousandSeparator:"",undoLimit:20,useRegularExpressions:!1,useWildcards:!0,useColumnIndex:!1,useStats:!1,useArrayArithmetic:!1}},function(e,t,r){"use strict";t.__esModule=!0,t.configCheckIfParametersNotInConflict=function(...e){const t=new Map;e.forEach(e=>{const r=t.get(e.value)||[];r.push(e.name),t.set(e.value,r)});const r=[];for(const e of t.values())e.length>1&&r.push(e);if(r.length>0){r.forEach(e=>e.sort());const e=r.map(e=>`[${e}]`).join("; ");throw new Error("Config initialization failed. Parameters in conflict: "+e)}},t.configValueFromParam= /** * @license * Copyright (c) 2024 Handsoncode. All rights reserved. @@ -928,7 +928,7 @@ function(e,t,r,n){const c=r.stringifyDateTime(n.numberToSimpleDateTime(e),t);if( * @license * Copyright (c) 2024 Handsoncode. All rights reserved. */ -const n=/(\\.|dd|DD|d|D|mm|MM|m|M|YYYY|YY|yyyy|yy|HH|hh|H|h|ss(\.(0+|s+))?|s|AM\/PM|am\/pm|A\/P|a\/p|\[mm]|\[MM]|\[hh]|\[HH])/g,o=/(\\.|[#0]+(\.[#0]*)?)/g;var s,i;function a(e,t){return{type:e,value:t}}function u(e,t){const r=[];let n=0;for(let o=0;oh(e))?void 0:{type:i.DATE,tokens:u(t,e)}}function l(e){const t=function(e){o.lastIndex=0;const t=o.exec(e);return null!==t?[t]:[]}(e);return t.every(e=>h(e))?void 0:{type:i.NUMBER,tokens:u(t,e)}}function h(e){return e[0].startsWith("\\")}!function(e){e.FORMAT="FORMAT",e.FREE_TEXT="FREE_TEXT"}(s||(t.TokenType=s={})),function(e){e.DATE="DATE",e.NUMBER="NUMBER",e.STRING="STRING"}(i||(t.FormatExpressionType=i={}))},function(e,t,r){"use strict";t.__esModule=!0,t.checkLicenseKeyValidity=function(e){const t={template:"missing",vars:{}};if("gpl-v3"===e||"internal-use-in-handsontable"===e)t.template="valid";else if("string"==typeof e&&(0,n.checkKeySchema)(e)){const[r,o,s]="15/02/2024".split("/"),i=Math.floor(new Date(`${o}/${r}/${s}`).getTime()/864e5),a=(0,n.extractTime)(e);t.vars.keyValidityDate=function(e){const t=["January","February","March","April","May","June","July","August","September","October","November","December"][e.getMonth()],r=e.getDate(),n=e.getFullYear();return`${t} ${r}, ${n}`}(new Date(864e5*(a+1))),t.template=i>a?"expired":"valid"}else""!==e&&(t.template="invalid");return s||"valid"===t.template||(console.warn(o[t.template](t.vars)),s=!0),t.template};var n=r(179); +const n=/(\\.|dd|DD|d|D|mm|MM|m|M|YYYY|YY|yyyy|yy|HH|hh|H|h|ss(\.(0+|s+))?|s|AM\/PM|am\/pm|A\/P|a\/p|\[mm]|\[MM]|\[hh]|\[HH])/g,o=/(\\.|[#0]+(\.[#0]*)?)/g;var s,i;function a(e,t){return{type:e,value:t}}function u(e,t){const r=[];let n=0;for(let o=0;oh(e))?void 0:{type:i.DATE,tokens:u(t,e)}}function l(e){const t=function(e){o.lastIndex=0;const t=o.exec(e);return null!==t?[t]:[]}(e);return t.every(e=>h(e))?void 0:{type:i.NUMBER,tokens:u(t,e)}}function h(e){return e[0].startsWith("\\")}!function(e){e.FORMAT="FORMAT",e.FREE_TEXT="FREE_TEXT"}(s||(t.TokenType=s={})),function(e){e.DATE="DATE",e.NUMBER="NUMBER",e.STRING="STRING"}(i||(t.FormatExpressionType=i={}))},function(e,t,r){"use strict";t.__esModule=!0,t.checkLicenseKeyValidity=function(e){const t={template:"missing",vars:{}};if("gpl-v3"===e||"internal-use-in-handsontable"===e)t.template="valid";else if("string"==typeof e&&(0,n.checkKeySchema)(e)){const[r,o,s]="10/04/2024".split("/"),i=Math.floor(new Date(`${o}/${r}/${s}`).getTime()/864e5),a=(0,n.extractTime)(e);t.vars.keyValidityDate=function(e){const t=["January","February","March","April","May","June","July","August","September","October","November","December"][e.getMonth()],r=e.getDate(),n=e.getFullYear();return`${t} ${r}, ${n}`}(new Date(864e5*(a+1))),t.template=i>a?"expired":"valid"}else""!==e&&(t.template="invalid");return s||"valid"===t.template||(console.warn(o[t.template](t.vars)),s=!0),t.template};var n=r(179); /** * @license * Copyright (c) 2024 Handsoncode. All rights reserved. @@ -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)}validateFormula(e){(0,o.validateArgToType)(e,"string","formulaString");const{ast:t}=this.extractTemporaryFormula(e);return void 0!==t&&!(t.type===f.AstNodeType.ERROR&&!t.error)}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.6.2",E.buildDate="15/02/2024 11:09:54",E.releaseDate="15/02/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="10/04/2024 09:34:42",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.6277c385.js b/assets/js/25.6277c385.js deleted file mode 100644 index 417bc9e09..000000000 --- a/assets/js/25.6277c385.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{318: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:"configuration-options"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),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:"event-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#event-types"}},[t._v("#")]),t._v(" Event Types")]),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/25.c3bd68f4.js b/assets/js/25.c3bd68f4.js new file mode 100644 index 000000000..ba6051107 --- /dev/null +++ b/assets/js/25.c3bd68f4.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{318: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/26.b36353fc.js b/assets/js/26.b36353fc.js new file mode 100644 index 000000000..0d6243ea7 --- /dev/null +++ b/assets/js/26.b36353fc.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{319: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:"api-reference-overview"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#api-reference-overview"}},[t._v("#")]),t._v(" API Reference Overview")]),t._v(" "),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/26.ced5b227.js b/assets/js/26.ced5b227.js deleted file mode 100644 index 0814d4362..000000000 --- a/assets/js/26.ced5b227.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{320: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:"hyperformula-api-reference"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula-api-reference"}},[t._v("#")]),t._v(" HyperFormula API reference")]),t._v(" "),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:"configuration-options"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),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:"event-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#event-types"}},[t._v("#")]),t._v(" Event Types")]),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.466255ed.js b/assets/js/27.466255ed.js deleted file mode 100644 index 59ccf5223..000000000 --- a/assets/js/27.466255ed.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{319:function(e,t,r){"use strict";r.r(t);var a=r(14),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"config"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#config"}},[e._v("#")]),e._v(" Config "),t("Badge",{attrs:{text:"Class"}})],1),e._v(" "),t("h2",{attrs:{id:"constructors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),t("h3",{attrs:{id:"constructor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),t("p",[e._v("+ "),t("strong",[e._v("new Config")]),e._v("("),t("code",[e._v("options")]),e._v(": Partial‹"),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")]),e._v("›, "),t("code",[e._v("showDeprecatedWarns")]),e._v(": boolean): "),t("em",[t("RouterLink",{attrs:{to:"/api/classes/config.html"}},[e._v("Config")])],1)],1),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:617"),t("OutboundLink")],1)])]),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("th",[e._v("Default")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("options")])]),e._v(" "),t("td",[e._v("Partial‹"),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")]),e._v("›")],1),e._v(" "),t("td",[e._v("{}")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("showDeprecatedWarns")])]),e._v(" "),t("td",[e._v("boolean")]),e._v(" "),t("td",[e._v("true")])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("em",[t("RouterLink",{attrs:{to:"/api/classes/config.html"}},[e._v("Config")])],1)]),e._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("h3",{attrs:{id:"accentsensitive"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accentsensitive"}},[e._v("#")]),e._v(" accentSensitive "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L539",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:539"),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:"arraycolumnseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arraycolumnseparator"}},[e._v("#")]),e._v(" arrayColumnSeparator "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L549",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:549"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L551",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:551"),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:"binarysearchthreshold"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#binarysearchthreshold"}},[e._v("#")]),e._v(" binarySearchThreshold "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L592",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:592"),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:"casefirst"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casefirst"}},[e._v("#")]),e._v(" caseFirst "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L541",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:541"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L535",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:535"),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:"chooseaddressmappingpolicy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chooseaddressmappingpolicy"}},[e._v("#")]),e._v(" chooseAddressMappingPolicy "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L537",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:537"),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:"currencysymbol"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#currencysymbol"}},[e._v("#")]),e._v(" currencySymbol "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L596",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:596"),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:"dateformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dateformats"}},[e._v("#")]),e._v(" dateFormats "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L543",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:543"),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:"decimalseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decimalseparator"}},[e._v("#")]),e._v(" decimalSeparator "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L553",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:553"),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/classes/config.html#readonly-thousandseparator"}},[e._v("thousandSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/classes/config.html#readonly-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:"evaluatenulltozero"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluatenulltozero"}},[e._v("#")]),e._v(" evaluateNullToZero "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L572",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:572"),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:"functionargseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionargseparator"}},[e._v("#")]),e._v(" functionArgSeparator "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L547",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:547"),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/classes/config.html#readonly-decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/classes/config.html#readonly-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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionPlugins")]),e._v(": "),t("em",[e._v("FunctionPluginDefinition[]")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L564",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:564"),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:"ignorepunctuation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorepunctuation"}},[e._v("#")]),e._v(" ignorePunctuation "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L568",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:568"),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:"ignorewhitespace"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorewhitespace"}},[e._v("#")]),e._v(" ignoreWhiteSpace "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L559",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:559"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L557",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:557"),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("h3",{attrs:{id:"leapyear1900"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#leapyear1900"}},[e._v("#")]),e._v(" leapYear1900 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L566",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:566"),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/classes/config.html#readonly-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:"licensekey"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licensekey"}},[e._v("#")]),e._v(" licenseKey "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L561",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:561"),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("h3",{attrs:{id:"localelang"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#localelang"}},[e._v("#")]),e._v(" localeLang "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L570",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:570"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:617"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"maxcolumns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxcolumns"}},[e._v("#")]),e._v(" maxColumns "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L608",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:608"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L606",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:606"),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:"nulldate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nulldate"}},[e._v("#")]),e._v(" nullDate "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L594",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:594"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L574",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:574"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L576",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:576"),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:"precisionepsilon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionepsilon"}},[e._v("#")]),e._v(" precisionEpsilon "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L582",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:582"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L584",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:584"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L586",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:586"),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/classes/config.html#readonly-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:"stringifydatetime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifydatetime"}},[e._v("#")]),e._v(" stringifyDateTime "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L578",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:578"),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("date")]),e._v(": SimpleDateTime, "),t("code",[e._v("formatArg")]),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("date")])]),e._v(" "),t("td",[e._v("SimpleDateTime")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("formatArg")])]),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L580",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:580"),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("formatArg")]),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("formatArg")])]),e._v(" "),t("td",[e._v("string")])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"thousandseparator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#thousandseparator"}},[e._v("#")]),e._v(" thousandSeparator "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L555",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:555"),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/classes/config.html#readonly-decimalseparator"}},[e._v("decimalSeparator")]),e._v(" and "),t("RouterLink",{attrs:{to:"/api/classes/config.html#readonly-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:"timeformats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#timeformats"}},[e._v("#")]),e._v(" timeFormats "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L545",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:545"),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("h3",{attrs:{id:"undolimit"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undolimit"}},[e._v("#")]),e._v(" undoLimit "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L598",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:598"),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("h3",{attrs:{id:"usearrayarithmetic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usearrayarithmetic"}},[e._v("#")]),e._v(" useArrayArithmetic "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L533",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:533"),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 "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L588",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:588"),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:"useregularexpressions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#useregularexpressions"}},[e._v("#")]),e._v(" useRegularExpressions "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L615",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:615"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"usestats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usestats"}},[e._v("#")]),e._v(" useStats "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L590",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:590"),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("h3",{attrs:{id:"usewildcards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usewildcards"}},[e._v("#")]),e._v(" useWildcards "),t("Badge",{attrs:{text:"Readonly",vertical:"middle"}})],1),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/14f7ffc/src/Config.ts#L616",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:616"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"methods"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),t("h3",{attrs:{id:"getconfig"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getconfig"}},[e._v("#")]),e._v(" getConfig")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("getConfig")]),e._v("(): "),t("em",[t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L755",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:755"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("em",[t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"mergeconfig"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#mergeconfig"}},[e._v("#")]),e._v(" mergeConfig")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("mergeConfig")]),e._v("("),t("code",[e._v("init")]),e._v(": Partial‹"),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")]),e._v("›): "),t("em",[t("RouterLink",{attrs:{to:"/api/classes/config.html"}},[e._v("Config")])],1)],1),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L759",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:759"),t("OutboundLink")],1)])]),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("init")])]),e._v(" "),t("td",[e._v("Partial‹"),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[e._v("ConfigParams")]),e._v("›")],1)])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("em",[t("RouterLink",{attrs:{to:"/api/classes/config.html"}},[e._v("Config")])],1)]),e._v(" "),t("h2",{attrs:{id:"object-literals"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#object-literals"}},[e._v("#")]),e._v(" Object literals")]),e._v(" "),t("h3",{attrs:{id:"defaultconfig"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defaultconfig"}},[e._v("#")]),e._v(" defaultConfig "),t("Badge",{attrs:{text:"Static",vertical:"middle"}})],1),e._v(" "),t("h3",{attrs:{id:"▪-defaultconfig-object"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#▪-defaultconfig-object"}},[e._v("#")]),e._v(" ▪ "),t("strong",[e._v("defaultConfig")]),e._v(": "),t("em",[e._v("object")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L491",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:491"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"accentsensitive-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#accentsensitive-2"}},[e._v("#")]),e._v(" accentSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("accentSensitive")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L492",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:492"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"arraycolumnseparator-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arraycolumnseparator-2"}},[e._v("#")]),e._v(" arrayColumnSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayColumnSeparator")]),e._v(": "),t("em",[e._v('","')]),e._v(' = ","')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L510",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:510"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"arrayrowseparator-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arrayrowseparator-2"}},[e._v("#")]),e._v(" arrayRowSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("arrayRowSeparator")]),e._v(": "),t("em",[e._v('";"')]),e._v(' = ";"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L511",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:511"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"binarysearchthreshold-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#binarysearchthreshold-2"}},[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(" = 20")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L493",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:493"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"casefirst-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casefirst-2"}},[e._v("#")]),e._v(" caseFirst")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseFirst")]),e._v(": "),t("em",[e._v('"lower"')]),e._v(' = "lower"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L496",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:496"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"casesensitive-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#casesensitive-2"}},[e._v("#")]),e._v(" caseSensitive")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("caseSensitive")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L495",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:495"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"chooseaddressmappingpolicy-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chooseaddressmappingpolicy-2"}},[e._v("#")]),e._v(" chooseAddressMappingPolicy")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("chooseAddressMappingPolicy")]),e._v(": "),t("em",[e._v("AlwaysDense‹›")]),e._v(" = new AlwaysDense()")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L497",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:497"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"currencysymbol-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#currencysymbol-2"}},[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(" = ['$']")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L494",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:494"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"dateformats-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dateformats-2"}},[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(" = ['DD/MM/YYYY', 'DD/MM/YY']")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L498",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:498"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"decimalseparator-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#decimalseparator-2"}},[e._v("#")]),e._v(" decimalSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("decimalSeparator")]),e._v(": "),t("em",[e._v('"."')]),e._v(' = "."')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L499",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:499"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"evaluatenulltozero-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#evaluatenulltozero-2"}},[e._v("#")]),e._v(" evaluateNullToZero")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("evaluateNullToZero")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L500",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:500"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"functionargseparator-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionargseparator-2"}},[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(' = ","')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L501",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:501"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"functionplugins-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functionplugins-2"}},[e._v("#")]),e._v(" functionPlugins")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("functionPlugins")]),e._v(": "),t("em",[e._v("never[]")]),e._v(" = []")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L502",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:502"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"ignorepunctuation-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorepunctuation-2"}},[e._v("#")]),e._v(" ignorePunctuation")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignorePunctuation")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L503",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:503"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"ignorewhitespace-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ignorewhitespace-2"}},[e._v("#")]),e._v(" ignoreWhiteSpace")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("ignoreWhiteSpace")]),e._v(": "),t("em",[e._v('"standard"')]),e._v(' = "standard"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L505",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:505"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"language-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#language-2"}},[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(' = "enGB"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L504",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:504"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"leapyear1900-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#leapyear1900-2"}},[e._v("#")]),e._v(" leapYear1900")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("leapYear1900")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L507",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:507"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"licensekey-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licensekey-2"}},[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(' = ""')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L506",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:506"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"localelang-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#localelang-2"}},[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(' = "en"')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L508",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:508"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"matchwholecell-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#matchwholecell-2"}},[e._v("#")]),e._v(" matchWholeCell")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("matchWholeCell")]),e._v(": "),t("em",[e._v("true")]),e._v(" = true")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L509",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:509"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"maxcolumns-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxcolumns-2"}},[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(" = 18278")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L513",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:513"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"maxrows-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maxrows-2"}},[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(" = 40000")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L512",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:512"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"nullyear-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nullyear-2"}},[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(" = 30")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L514",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:514"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"parsedatetime-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsedatetime-2"}},[e._v("#")]),e._v(" parseDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("parseDateTime")]),e._v(": "),t("em",[e._v("defaultParseToDateTime")]),e._v(" = defaultParseToDateTime")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L516",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:516"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"precisionepsilon-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionepsilon-2"}},[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(" = 1e-13")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L517",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:517"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"precisionrounding-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#precisionrounding-2"}},[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(" = 14")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L518",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:518"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"smartrounding-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#smartrounding-2"}},[e._v("#")]),e._v(" smartRounding")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("smartRounding")]),e._v(": "),t("em",[e._v("true")]),e._v(" = true")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L519",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:519"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"stringifydatetime-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifydatetime-2"}},[e._v("#")]),e._v(" stringifyDateTime")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDateTime")]),e._v(": "),t("em",[e._v("defaultStringifyDateTime")]),e._v(" = defaultStringifyDateTime")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L520",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:520"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"stringifyduration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stringifyduration-2"}},[e._v("#")]),e._v(" stringifyDuration")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("stringifyDuration")]),e._v(": "),t("em",[e._v("defaultStringifyDuration")]),e._v(" = defaultStringifyDuration")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L521",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:521"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"thousandseparator-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#thousandseparator-2"}},[e._v("#")]),e._v(" thousandSeparator")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("thousandSeparator")]),e._v(": "),t("em",[e._v('""')]),e._v(' = ""')]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L523",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:523"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"timeformats-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#timeformats-2"}},[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(" = ['hh:mm', 'hh:mm:ss.sss']")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L522",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:522"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"undolimit-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#undolimit-2"}},[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(" = 20")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L524",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:524"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"usearrayarithmetic-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usearrayarithmetic-2"}},[e._v("#")]),e._v(" useArrayArithmetic")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useArrayArithmetic")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L529",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:529"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"usecolumnindex-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usecolumnindex-2"}},[e._v("#")]),e._v(" useColumnIndex")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useColumnIndex")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L527",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:527"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"useregularexpressions-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#useregularexpressions-2"}},[e._v("#")]),e._v(" useRegularExpressions")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useRegularExpressions")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L525",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:525"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"usestats-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usestats-2"}},[e._v("#")]),e._v(" useStats")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useStats")]),e._v(": "),t("em",[e._v("false")]),e._v(" = false")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L528",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:528"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"usewildcards-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usewildcards-2"}},[e._v("#")]),e._v(" useWildcards")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("useWildcards")]),e._v(": "),t("em",[e._v("true")]),e._v(" = true")]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L526",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:526"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("▪ "),t("strong",[e._v("nullDate")]),e._v(": "),t("em",[e._v("object")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L515",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:515"),t("OutboundLink")],1)])]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[e._v("day")]),e._v(": "),t("em",[e._v("number")]),e._v(" = 30")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("month")]),e._v(": "),t("em",[e._v("number")]),e._v(" = 12")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("year")]),e._v(": "),t("em",[e._v("number")]),e._v(" = 1899")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/28.7823806f.js b/assets/js/27.b68f50df.js similarity index 95% rename from assets/js/28.7823806f.js rename to assets/js/27.b68f50df.js index 787ea257d..b3148410b 100644 --- a/assets/js/28.7823806f.js +++ b/assets/js/27.b68f50df.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{321: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/14f7ffc/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],{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/03fefd5/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/29.dd3990e2.js b/assets/js/28.8f1f5da4.js similarity index 75% rename from assets/js/29.dd3990e2.js rename to assets/js/28.8f1f5da4.js index 5a62c25f2..94b21114a 100644 --- a/assets/js/29.dd3990e2.js +++ b/assets/js/28.8f1f5da4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{323: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(" = '15/02/2024 11:09:54'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/HyperFormula.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:100"),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/14f7ffc/src/HyperFormula.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:116"),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(" = '15/02/2024'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/HyperFormula.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:107"),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.6.2'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/HyperFormula.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:93"),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/14f7ffc/src/HyperFormula.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:155"),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/14f7ffc/src/HyperFormula.ts#L327",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:327"),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/14f7ffc/src/HyperFormula.ts#L267",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:267"),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/14f7ffc/src/HyperFormula.ts#L307",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:307"),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/14f7ffc/src/HyperFormula.ts#L4371",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4371"),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/14f7ffc/src/HyperFormula.ts#L1018",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1018"),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/14f7ffc/src/HyperFormula.ts#L1032",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1032"),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/14f7ffc/src/HyperFormula.ts#L997",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:997"),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/14f7ffc/src/HyperFormula.ts#L2570",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2570"),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/14f7ffc/src/HyperFormula.ts#L2717",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2717"),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/14f7ffc/src/HyperFormula.ts#L3357",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3357"),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/14f7ffc/src/HyperFormula.ts#L3080",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3080"),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/14f7ffc/src/HyperFormula.ts#L881",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:881"),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/14f7ffc/src/HyperFormula.ts#L950",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:950"),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/14f7ffc/src/HyperFormula.ts#L971",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:971"),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/14f7ffc/src/HyperFormula.ts#L931",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:931"),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/14f7ffc/src/HyperFormula.ts#L906",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:906"),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/14f7ffc/src/HyperFormula.ts#L818",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:818"),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/14f7ffc/src/HyperFormula.ts#L3055",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3055"),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/14f7ffc/src/HyperFormula.ts#L3009",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3009"),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/14f7ffc/src/HyperFormula.ts#L3031",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3031"),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/14f7ffc/src/HyperFormula.ts#L851",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:851"),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/14f7ffc/src/HyperFormula.ts#L785",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:785"),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/14f7ffc/src/HyperFormula.ts#L2533",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2533"),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/14f7ffc/src/HyperFormula.ts#L2675",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2675"),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/14f7ffc/src/HyperFormula.ts#L2601",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2601"),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/14f7ffc/src/HyperFormula.ts#L3384",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3384"),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/14f7ffc/src/HyperFormula.ts#L2747",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2747"),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/14f7ffc/src/HyperFormula.ts#L2644",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2644"),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/14f7ffc/src/HyperFormula.ts#L3420",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3420"),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/14f7ffc/src/HyperFormula.ts#L2784",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2784"),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/14f7ffc/src/HyperFormula.ts#L2489",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2489"),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/14f7ffc/src/HyperFormula.ts#L2419",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2419"),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/14f7ffc/src/HyperFormula.ts#L2455",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2455"),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/14f7ffc/src/HyperFormula.ts#L2383",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2383"),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/14f7ffc/src/HyperFormula.ts#L1640",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1640"),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/14f7ffc/src/HyperFormula.ts#L1598",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1598"),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/14f7ffc/src/HyperFormula.ts#L1995",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1995"),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/14f7ffc/src/HyperFormula.ts#L1671",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1671"),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/14f7ffc/src/HyperFormula.ts#L1401",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1401"),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/14f7ffc/src/HyperFormula.ts#L1322",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1322"),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/14f7ffc/src/HyperFormula.ts#L2042",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2042"),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/14f7ffc/src/HyperFormula.ts#L1712",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1712"),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/14f7ffc/src/HyperFormula.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1370"),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/14f7ffc/src/HyperFormula.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1291"),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/14f7ffc/src/HyperFormula.ts#L1788",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1788"),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/14f7ffc/src/HyperFormula.ts#L1742",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1742"),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/14f7ffc/src/HyperFormula.ts#L2077",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2077"),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/14f7ffc/src/HyperFormula.ts#L1818",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1818"),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/14f7ffc/src/HyperFormula.ts#L1562",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1562"),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/14f7ffc/src/HyperFormula.ts#L1487",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1487"),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/14f7ffc/src/HyperFormula.ts#L2130",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2130"),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/14f7ffc/src/HyperFormula.ts#L1863",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1863"),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/14f7ffc/src/HyperFormula.ts#L1532",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1532"),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/14f7ffc/src/HyperFormula.ts#L1459",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1459"),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/14f7ffc/src/HyperFormula.ts#L3172",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3172"),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/14f7ffc/src/HyperFormula.ts#L3141",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3141"),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/14f7ffc/src/HyperFormula.ts#L691",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:691"),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/14f7ffc/src/HyperFormula.ts#L721",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:721"),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/14f7ffc/src/HyperFormula.ts#L753",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:753"),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/14f7ffc/src/HyperFormula.ts#L3109",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3109"),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/14f7ffc/src/HyperFormula.ts#L660",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:660"),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/14f7ffc/src/HyperFormula.ts#L3299",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3299"),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/14f7ffc/src/HyperFormula.ts#L3333",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3333"),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/14f7ffc/src/HyperFormula.ts#L3265",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3265"),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/14f7ffc/src/HyperFormula.ts#L3204",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3204"),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/14f7ffc/src/HyperFormula.ts#L3232",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3232"),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/14f7ffc/src/HyperFormula.ts#L1899",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1899"),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/14f7ffc/src/HyperFormula.ts#L1186",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1186"),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/14f7ffc/src/HyperFormula.ts#L1956",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1956"),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/14f7ffc/src/HyperFormula.ts#L1239",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1239"),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/14f7ffc/src/HyperFormula.ts#L3650",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3650"),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/14f7ffc/src/HyperFormula.ts#L3866",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3866"),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/14f7ffc/src/HyperFormula.ts#L4030",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4030"),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/14f7ffc/src/HyperFormula.ts#L3769",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3769"),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/14f7ffc/src/HyperFormula.ts#L3726",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3726"),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/14f7ffc/src/HyperFormula.ts#L3686",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3686"),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/14f7ffc/src/HyperFormula.ts#L3598",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3598"),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/14f7ffc/src/HyperFormula.ts#L3818",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3818"),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/14f7ffc/src/HyperFormula.ts#L3902",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3902"),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/14f7ffc/src/HyperFormula.ts#L3994",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3994"),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/14f7ffc/src/HyperFormula.ts#L3947",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3947"),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/14f7ffc/src/HyperFormula.ts#L4095",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4095"),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/14f7ffc/src/HyperFormula.ts#L2936",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2936"),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/14f7ffc/src/HyperFormula.ts#L2974",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2974"),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:"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/14f7ffc/src/HyperFormula.ts#L4059",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4059"),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/14f7ffc/src/HyperFormula.ts#L4247",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4247"),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/14f7ffc/src/HyperFormula.ts#L4223",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4223"),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/14f7ffc/src/HyperFormula.ts#L4270",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4270"),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/14f7ffc/src/HyperFormula.ts#L2820",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2820"),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/14f7ffc/src/HyperFormula.ts#L2872",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2872"),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/14f7ffc/src/HyperFormula.ts#L2847",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2847"),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/14f7ffc/src/HyperFormula.ts#L2903",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2903"),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",[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/14f7ffc/src/HyperFormula.ts#L4124",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4124"),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/14f7ffc/src/HyperFormula.ts#L2302",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2302"),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/14f7ffc/src/HyperFormula.ts#L2166",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2166"),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/14f7ffc/src/HyperFormula.ts#L2204",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2204"),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/14f7ffc/src/HyperFormula.ts#L2285",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2285"),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/14f7ffc/src/HyperFormula.ts#L2253",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2253"),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/14f7ffc/src/HyperFormula.ts#L2330",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2330"),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/14f7ffc/src/HyperFormula.ts#L2355",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2355"),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/14f7ffc/src/HyperFormula.ts#L1154",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1154"),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/14f7ffc/src/HyperFormula.ts#L1137",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1137"),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/14f7ffc/src/HyperFormula.ts#L1111",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1111"),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/14f7ffc/src/HyperFormula.ts#L1075",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1075"),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/14f7ffc/src/HyperFormula.ts#L3460",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3460"),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/14f7ffc/src/HyperFormula.ts#L3569",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3569"),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/14f7ffc/src/HyperFormula.ts#L3543",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3543"),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/14f7ffc/src/HyperFormula.ts#L3507",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3507"),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/14f7ffc/src/HyperFormula.ts#L4356",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4356"),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/14f7ffc/src/HyperFormula.ts#L4296",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4296"),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/14f7ffc/src/HyperFormula.ts#L4322",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4322"),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/14f7ffc/src/HyperFormula.ts#L4199",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4199"),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/14f7ffc/src/HyperFormula.ts#L4181",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4181"),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/14f7ffc/src/HyperFormula.ts#L4153",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4153"),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/14f7ffc/src/HyperFormula.ts#L612",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:612"),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/14f7ffc/src/HyperFormula.ts#L596",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:596"),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/14f7ffc/src/HyperFormula.ts#L347",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:347"),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/14f7ffc/src/HyperFormula.ts#L568",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:568"),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/14f7ffc/src/HyperFormula.ts#L426",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:426"),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/14f7ffc/src/HyperFormula.ts#L504",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:504"),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/14f7ffc/src/HyperFormula.ts#L454",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:454"),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/14f7ffc/src/HyperFormula.ts#L378",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:378"),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/14f7ffc/src/HyperFormula.ts#L549",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:549"),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/14f7ffc/src/HyperFormula.ts#L532",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:532"),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/14f7ffc/src/HyperFormula.ts#L476",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:476"),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/14f7ffc/src/HyperFormula.ts#L406",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:406"),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],{324: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 09:34:42'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/30.a5e33487.js b/assets/js/29.ff4f27fc.js similarity index 86% rename from assets/js/30.a5e33487.js rename to assets/js/29.ff4f27fc.js index db3f52ed3..5e82003c5 100644 --- a/assets/js/30.a5e33487.js +++ b/assets/js/29.ff4f27fc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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.826eca9c.js b/assets/js/30.826eca9c.js new file mode 100644 index 000000000..c0fee5e96 --- /dev/null +++ b/assets/js/30.826eca9c.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{321: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/03fefd5/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.74aed731.js b/assets/js/31.74aed731.js new file mode 100644 index 000000000..8e4013c62 --- /dev/null +++ b/assets/js/31.74aed731.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{323: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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/31.d69db2c5.js b/assets/js/31.d69db2c5.js deleted file mode 100644 index 5d2e3d49e..000000000 --- a/assets/js/31.d69db2c5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{324:function(t,a,r){"use strict";r.r(a);var e=r(14),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hyperformula-api-reference"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hyperformula-api-reference"}},[t._v("#")]),t._v(" HyperFormula API reference")]),t._v(" "),a("h2",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("h3",{attrs:{id:"configparamslist"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configparamslist"}},[t._v("#")]),t._v(" ConfigParamsList")]),t._v(" "),a("p",[t._v("Ƭ "),a("strong",[t._v("ConfigParamsList")]),t._v(": "),a("em",[t._v("keyof ConfigParams")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L487",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Config.ts:487"),a("OutboundLink")],1)])]),t._v(" "),a("h2",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("h3",{attrs:{id:"privatepool"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#privatepool"}},[t._v("#")]),t._v(" privatePool "),a("Badge",{attrs:{text:"Const",vertical:"middle"}})],1),t._v(" "),a("p",[t._v("• "),a("strong",[t._v("privatePool")]),t._v(": "),a("em",[t._v("WeakMap‹"),a("RouterLink",{attrs:{to:"/api/classes/config.html"}},[t._v("Config")]),t._v(", object›")],1),t._v(" = new WeakMap()")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Config.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("h2",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("h3",{attrs:{id:"getdefaultconfig"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getdefaultconfig"}},[t._v("#")]),t._v(" getDefaultConfig")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("getDefaultConfig")]),t._v("(): "),a("em",[a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L797",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Config.ts:797"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("em",[a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h3",{attrs:{id:"getfullconfigfrompartial"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getfullconfigfrompartial"}},[t._v("#")]),t._v(" getFullConfigFromPartial")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("getFullConfigFromPartial")]),t._v("("),a("code",[t._v("partialConfig")]),t._v(": Partial‹"),a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›): "),a("em",[a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/14f7ffc/src/Config.ts#L783",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/Config.ts:783"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("partialConfig")])]),t._v(" "),a("td",[t._v("Partial‹"),a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")]),t._v("›")],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("em",[a("RouterLink",{attrs:{to:"/api/interfaces/configparams.html"}},[t._v("ConfigParams")])],1)])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/32.8ba41b4c.js b/assets/js/32.8ba41b4c.js deleted file mode 100644 index d934897e1..000000000 --- a/assets/js/32.8ba41b4c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{325:function(e,t,r){"use strict";r.r(t);var a=r(14),o=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/14f7ffc/src/Config.ts#L220",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:220"),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/14f7ffc/src/Config.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:48"),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/14f7ffc/src/Config.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:83"),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:"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/14f7ffc/src/Config.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:155"),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/14f7ffc/src/Config.ts#L271",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:271"),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/14f7ffc/src/Config.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:263"),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/14f7ffc/src/Config.ts#L440",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:440"),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/14f7ffc/src/Config.ts#L452",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:452"),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/14f7ffc/src/Config.ts#L462",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:462"),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/14f7ffc/src/Config.ts#L248",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:248"),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/14f7ffc/src/Config.ts#L255",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:255"),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/14f7ffc/src/Config.ts#L131",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:131"),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/14f7ffc/src/Config.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:164"),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/14f7ffc/src/Config.ts#L194",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:194"),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/14f7ffc/src/Config.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:182"),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/14f7ffc/src/Config.ts#L470",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:470"),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/14f7ffc/src/Config.ts#L119",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:119"),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/14f7ffc/src/Config.ts#L206",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:206"),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/14f7ffc/src/Config.ts#L283",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:283"),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/14f7ffc/src/Config.ts#L297",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:297"),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/14f7ffc/src/Config.ts#L309",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:309"),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/14f7ffc/src/Config.ts#L355",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:355"),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/14f7ffc/src/Config.ts#L367",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:367"),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/14f7ffc/src/Config.ts#L428",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:428"),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/14f7ffc/src/Config.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:93"),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/14f7ffc/src/Config.ts#L147",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:147"),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/14f7ffc/src/Config.ts#L326",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:326"),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/14f7ffc/src/Config.ts#L343",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:343"),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/14f7ffc/src/Config.ts#L377",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:377"),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/14f7ffc/src/Config.ts#L394",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:394"),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/14f7ffc/src/Config.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:38"),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/14f7ffc/src/Config.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:70"),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/14f7ffc/src/Config.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:58"),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/14f7ffc/src/Config.ts#L172",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:172"),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/14f7ffc/src/Config.ts#L232",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:232"),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/14f7ffc/src/Config.ts#L241",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:241"),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/14f7ffc/src/Config.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:477"),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/14f7ffc/src/Config.ts#L484",target:"_blank",rel:"noopener noreferrer"}},[e._v("src/Config.ts:484"),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=o.exports}}]); \ No newline at end of file diff --git a/assets/js/33.46087b17.js b/assets/js/32.e23940b3.js similarity index 98% rename from assets/js/33.46087b17.js rename to assets/js/32.e23940b3.js index c7d1f0503..52ef5a0d3 100644 --- a/assets/js/33.46087b17.js +++ b/assets/js/32.e23940b3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{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:"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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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/14f7ffc/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],{325: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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/03fefd5/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/34.71b5b766.js b/assets/js/33.efa2ca8a.js similarity index 90% rename from assets/js/34.71b5b766.js rename to assets/js/33.efa2ca8a.js index f597872e8..e9c0d8f8a 100644 --- a/assets/js/34.71b5b766.js +++ b/assets/js/33.efa2ca8a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{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/14f7ffc/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/14f7ffc/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/14f7ffc/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/03fefd5/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/03fefd5/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/03fefd5/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/35.c369b0fc.js b/assets/js/34.61ab12b3.js similarity index 96% rename from assets/js/35.c369b0fc.js rename to assets/js/34.61ab12b3.js index 078609757..27c748f11 100644 --- a/assets/js/35.c369b0fc.js +++ b/assets/js/34.61ab12b3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{328: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:"500px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.6.x/advanced-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview",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:"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 diff --git a/assets/js/36.b1a38952.js b/assets/js/35.2ba8f1de.js similarity index 99% rename from assets/js/36.b1a38952.js rename to assets/js/35.2ba8f1de.js index fd1ddff20..fec10a13d 100644 --- a/assets/js/36.b1a38952.js +++ b/assets/js/35.2ba8f1de.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{329:function(a,t,e){"use strict";e.r(t);var r=e(14),i=Object(r.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"array-formulas"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-formulas"}},[a._v("#")]),a._v(" Array formulas")]),a._v(" "),t("p",[a._v("Use array formulas to perform an operation (or call a function) on multiple cells at a time.")]),a._v(" "),t("h2",{attrs:{id:"about-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#about-arrays"}},[a._v("#")]),a._v(" About arrays")]),a._v(" "),t("p",[a._v("In HyperFormula, an array can be:")]),a._v(" "),t("ul",[t("li",[a._v("A range of cell addresses (e.g., "),t("code",[a._v("A1:A10")]),a._v(")")]),a._v(" "),t("li",[a._v("A result of an arithmetic operation (e.g., "),t("code",[a._v("5*A1:B5")]),a._v(")")]),a._v(" "),t("li",[a._v("A result of a function (e.g., "),t("code",[a._v("=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))")]),a._v(")")]),a._v(" "),t("li",[a._v("An "),t("strong",[a._v("inline array")]),a._v(": an ad-hoc array that doesn't reference any range of cells (e.g., "),t("code",[a._v("{1, 3, 5}")]),a._v(")")])]),a._v(" "),t("p",[a._v("An array is inherently a two-dimensional object.")]),a._v(" "),t("p",[t("code",[a._v("1")]),a._v("x"),t("code",[a._v("1")]),a._v(" arrays are treated as single, zero-dimensional values ("),t("strong",[a._v("scalars")]),a._v(").")]),a._v(" "),t("h3",{attrs:{id:"inline-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inline-arrays"}},[a._v("#")]),a._v(" Inline arrays")]),a._v(" "),t("p",[a._v("An inline array is defined by curly braces: "),t("code",[a._v("{ }")]),a._v(". It can contain one or more rows, separated by:")]),a._v(" "),t("ul",[t("li",[a._v("The "),t("RouterLink",{attrs:{to:"/api/classes/config.html#arraycolumnseparator"}},[t("code",[a._v("arrayColumnSeparator")])]),a._v(" (default: "),t("code",[a._v(",")]),a._v(")")],1),a._v(" "),t("li",[a._v("The "),t("RouterLink",{attrs:{to:"/api/classes/config.html#arrayrowseparator"}},[t("code",[a._v("arrayRowSeparator")])]),a._v(" (default: "),t("code",[a._v(";")]),a._v(")")],1)]),a._v(" "),t("p",[a._v("Every row must be of equal length.")]),a._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),t("p",[t("strong",[a._v("Inline arrays are not recomputed after initialization.")])]),a._v(" "),t("p",[a._v("If an inline array contains a cell reference, and the cell's value changes, the array is not updated.")])]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("= {1, 2, 3} // an inline array with a single row\n= {1, 2 ; 3, 4} // an inline array with two rows\n= SUM({1, 2, 3}) // an inline array as an argument of a function\n= {A1, A2} // when the values of A1 or A2 change, this inline array is not updated\n\n= {1, 2 ; 3} // an invalid inline array: two rows of different lengths\n")])])]),t("h2",{attrs:{id:"array-arithmetic-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-arithmetic-mode"}},[a._v("#")]),a._v(" Array arithmetic mode")]),a._v(" "),t("p",[a._v("To use array formulas in HyperFormula, you need to enable the "),t("strong",[a._v("array arithmetic mode")]),a._v(".")]),a._v(" "),t("p",[a._v("You can enable the array arithmetic mode:")]),a._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#enabling-the-array-arithmetic-mode-locally"}},[a._v("Locally")]),a._v(" (for an individual function or operation)")]),a._v(" "),t("li",[t("a",{attrs:{href:"#enabling-the-array-arithmetic-mode-globally"}},[a._v("Globally")]),a._v(" (for your HyperFormula instance)")])]),a._v(" "),t("h3",{attrs:{id:"enabling-the-array-arithmetic-mode-locally"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-the-array-arithmetic-mode-locally"}},[a._v("#")]),a._v(" Enabling the array arithmetic mode locally")]),a._v(" "),t("p",[a._v("To enable the array arithmetic mode once, within a particular function or formula, use the "),t("code",[a._v("ARRAYFORMULA")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAYFORMULA(your_array_formula)")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(A2:A5*B2:B5)")])])]),a._v(" "),t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAYFORMULA(YOUR_FUNCTION(your_array_formula))")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5*10))")])])])])]),a._v(" "),t("h3",{attrs:{id:"enabling-the-array-arithmetic-mode-globally"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-the-array-arithmetic-mode-globally"}},[a._v("#")]),a._v(" Enabling the array arithmetic mode globally")]),a._v(" "),t("p",[a._v("To enable the array arithmetic mode by default, everywhere in your HyperFormula instance:")]),a._v(" "),t("ul",[t("li",[a._v("In your HyperFormula "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#usearrayarithmetic"}},[a._v("configuration")]),a._v(", set the "),t("code",[a._v("useArrayArithmetic")]),a._v(" option to "),t("code",[a._v("true")]),a._v(".")],1)]),a._v(" "),t("p",[a._v("With the array arithmetic mode enabled globally, you can operate on arrays without using the "),t("code",[a._v("ARRAYFORMULA")]),a._v(" function:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=A2:A5*B2:B5\n\nISEVEN(A2:A5*10)\n")])])]),t("h2",{attrs:{id:"array-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-features"}},[a._v("#")]),a._v(" Array features")]),a._v(" "),t("p",[a._v("Thanks to HyperFormula's built-in array features, you can:")]),a._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#operating-on-arrays"}},[a._v("Operate on arrays")]),a._v(" just like on "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")])]),a._v(" "),t("li",[t("a",{attrs:{href:"#passing-arrays-to-scalar-functions-vectorization"}},[a._v("Pass arrays to functions")]),a._v(" that accept "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")])]),a._v(" "),t("li",[t("a",{attrs:{href:"#broadcasting"}},[a._v("Broadcast")]),a._v(" smaller input arrays across larger output areas")])]),a._v(" "),t("p",[a._v("You can also:")]),a._v(" "),t("ul",[t("li",[a._v("Use the "),t("code",[a._v("FILTER")]),a._v(" function to "),t("a",{attrs:{href:"#filtering-an-array"}},[a._v("filter an array")]),a._v(", based on boolean arrays")]),a._v(" "),t("li",[a._v("Use the "),t("code",[a._v("ARRAY_CONSTRAIN")]),a._v(" function to "),t("a",{attrs:{href:"#constraining-an-array-s-size"}},[a._v("constrain an array's size")])])]),a._v(" "),t("h3",{attrs:{id:"operating-on-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#operating-on-arrays"}},[a._v("#")]),a._v(" Operating on arrays")]),a._v(" "),t("p",[a._v("You can operate on arrays just like on single values.")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, each output array value is the result of your operation on the corresponding input array value.")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(A2:A5*B2:B5)\n\n// calculates:\n// =A2*B2\n// =A3*B3\n// =A4*B4\n// =A5*B5\n")])])]),t("h3",{attrs:{id:"passing-arrays-to-scalar-functions-vectorization"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#passing-arrays-to-scalar-functions-vectorization"}},[a._v("#")]),a._v(" Passing arrays to scalar functions (vectorization)")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, HyperFormula automatically "),t("em",[a._v("vectorizes")]),a._v(" most functions.")]),a._v(" "),t("p",[a._v("As a consequence of that, you can pass arrays to functions that would normally accept "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")]),a._v(". The result would also be an array.")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5))\n\n// calculates:\n// =ISEVEN(A2)\n// =ISEVEN(A3)\n// =ISEVEN(A4)\n// =ISEVEN(A5)\n")])])]),t("h3",{attrs:{id:"broadcasting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#broadcasting"}},[a._v("#")]),a._v(" Broadcasting")]),a._v(" "),t("p",[a._v("If an input array has a dimension of "),t("code",[a._v("1")]),a._v(', it\'s automatically repeated ("broadcast") on that dimension to match the size of the output.')]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5*B2))\n\n// calculates:\n// =ISEVEN(A2*B2)\n// =ISEVEN(A3*B2)\n// =ISEVEN(A4*B2)\n// =ISEVEN(A5*B2)\n")])])]),t("h3",{attrs:{id:"filtering-an-array"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#filtering-an-array"}},[a._v("#")]),a._v(" Filtering an array")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, you can filter an array, based on boolean arrays, using the "),t("code",[a._v("FILTER")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("FILTER(your_array, BoolArray1[, BoolArray2[, ...]]")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(FILTER(A2:A5*10), {1, 0, 0, 1})")])])])])]),a._v(" "),t("h3",{attrs:{id:"constraining-an-array-s-size"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constraining-an-array-s-size"}},[a._v("#")]),a._v(" Constraining an array's size")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, you can constrain the size of the output array, using the "),t("code",[a._v("ARRAY_CONSTRAIN")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAY_CONSTRAIN(your_array,height,width)")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))")])])])])]),a._v(" "),t("p",[a._v("If your specified output array size is smaller than the input array size, only the corresponding top-left cells of the input array are taken into account.")]),a._v(" "),t("p",[a._v("If your specified output array size is larger or equal to the input array size, no change is made.")]),a._v(" "),t("h2",{attrs:{id:"array-rules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-rules"}},[a._v("#")]),a._v(" Array rules")]),a._v(" "),t("h3",{attrs:{id:"with-the-array-arithmetic-mode-enabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-the-array-arithmetic-mode-enabled"}},[a._v("#")]),a._v(" With the array arithmetic mode enabled")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, and you pass an array to a "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalar")]),a._v(" function, the following rules apply:")]),a._v(" "),t("ul",[t("li",[a._v("Array dimensions need to be consistent (e.g., every row needs to be of the same length).")]),a._v(" "),t("li",[a._v("If an input array value is missing (due to a difference in dimensions), the corresponding output array value is "),t("code",[a._v("#N/A")]),a._v(".")]),a._v(" "),t("li",[a._v("If a cell evaluates to an array, the array values are spilled into neighboring cells (unless the neighboring cells are already filled)."),t("br"),a._v("This behavior doesn't apply to ranges, which return the "),t("code",[a._v("#VALUE!")]),a._v(" error in this case.")]),a._v(" "),t("li",[a._v("If one of input array dimensions is "),t("code",[a._v("1")]),a._v(" ("),t("code",[a._v("1")]),a._v("x"),t("code",[a._v("n")]),a._v(" or "),t("code",[a._v("n")]),a._v("x"),t("code",[a._v("1")]),a._v("), the array is repeated, to match the output array dimensions.")])]),a._v(" "),t("h3",{attrs:{id:"with-the-array-arithmetic-mode-disabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-the-array-arithmetic-mode-disabled"}},[a._v("#")]),a._v(" With the array arithmetic mode disabled")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is disabled, and you pass an array to a "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalar")]),a._v(" function, the array is reduced to 1 element (usually the array's top-left value).")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is disabled, and you operate on a range of width/height equal to "),t("code",[a._v("1")]),a._v(", the behavior depends on your array formula's location:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Your array formula's location")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Behavior")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[a._v("In the same row as as one of the range's elements")]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[a._v("Only that particular element is taken.")])]),a._v(" "),t("tr",[t("td",{staticStyle:{"text-align":"left"}},[a._v("Any other cell")]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("#VALUE!")]),a._v(" error")])])])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{328:function(a,t,e){"use strict";e.r(t);var r=e(14),i=Object(r.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"array-formulas"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-formulas"}},[a._v("#")]),a._v(" Array formulas")]),a._v(" "),t("p",[a._v("Use array formulas to perform an operation (or call a function) on multiple cells at a time.")]),a._v(" "),t("h2",{attrs:{id:"about-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#about-arrays"}},[a._v("#")]),a._v(" About arrays")]),a._v(" "),t("p",[a._v("In HyperFormula, an array can be:")]),a._v(" "),t("ul",[t("li",[a._v("A range of cell addresses (e.g., "),t("code",[a._v("A1:A10")]),a._v(")")]),a._v(" "),t("li",[a._v("A result of an arithmetic operation (e.g., "),t("code",[a._v("5*A1:B5")]),a._v(")")]),a._v(" "),t("li",[a._v("A result of a function (e.g., "),t("code",[a._v("=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))")]),a._v(")")]),a._v(" "),t("li",[a._v("An "),t("strong",[a._v("inline array")]),a._v(": an ad-hoc array that doesn't reference any range of cells (e.g., "),t("code",[a._v("{1, 3, 5}")]),a._v(")")])]),a._v(" "),t("p",[a._v("An array is inherently a two-dimensional object.")]),a._v(" "),t("p",[t("code",[a._v("1")]),a._v("x"),t("code",[a._v("1")]),a._v(" arrays are treated as single, zero-dimensional values ("),t("strong",[a._v("scalars")]),a._v(").")]),a._v(" "),t("h3",{attrs:{id:"inline-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inline-arrays"}},[a._v("#")]),a._v(" Inline arrays")]),a._v(" "),t("p",[a._v("An inline array is defined by curly braces: "),t("code",[a._v("{ }")]),a._v(". It can contain one or more rows, separated by:")]),a._v(" "),t("ul",[t("li",[a._v("The "),t("RouterLink",{attrs:{to:"/api/classes/config.html#arraycolumnseparator"}},[t("code",[a._v("arrayColumnSeparator")])]),a._v(" (default: "),t("code",[a._v(",")]),a._v(")")],1),a._v(" "),t("li",[a._v("The "),t("RouterLink",{attrs:{to:"/api/classes/config.html#arrayrowseparator"}},[t("code",[a._v("arrayRowSeparator")])]),a._v(" (default: "),t("code",[a._v(";")]),a._v(")")],1)]),a._v(" "),t("p",[a._v("Every row must be of equal length.")]),a._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),t("p",[t("strong",[a._v("Inline arrays are not recomputed after initialization.")])]),a._v(" "),t("p",[a._v("If an inline array contains a cell reference, and the cell's value changes, the array is not updated.")])]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("= {1, 2, 3} // an inline array with a single row\n= {1, 2 ; 3, 4} // an inline array with two rows\n= SUM({1, 2, 3}) // an inline array as an argument of a function\n= {A1, A2} // when the values of A1 or A2 change, this inline array is not updated\n\n= {1, 2 ; 3} // an invalid inline array: two rows of different lengths\n")])])]),t("h2",{attrs:{id:"array-arithmetic-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-arithmetic-mode"}},[a._v("#")]),a._v(" Array arithmetic mode")]),a._v(" "),t("p",[a._v("To use array formulas in HyperFormula, you need to enable the "),t("strong",[a._v("array arithmetic mode")]),a._v(".")]),a._v(" "),t("p",[a._v("You can enable the array arithmetic mode:")]),a._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#enabling-the-array-arithmetic-mode-locally"}},[a._v("Locally")]),a._v(" (for an individual function or operation)")]),a._v(" "),t("li",[t("a",{attrs:{href:"#enabling-the-array-arithmetic-mode-globally"}},[a._v("Globally")]),a._v(" (for your HyperFormula instance)")])]),a._v(" "),t("h3",{attrs:{id:"enabling-the-array-arithmetic-mode-locally"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-the-array-arithmetic-mode-locally"}},[a._v("#")]),a._v(" Enabling the array arithmetic mode locally")]),a._v(" "),t("p",[a._v("To enable the array arithmetic mode once, within a particular function or formula, use the "),t("code",[a._v("ARRAYFORMULA")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAYFORMULA(your_array_formula)")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(A2:A5*B2:B5)")])])]),a._v(" "),t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAYFORMULA(YOUR_FUNCTION(your_array_formula))")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5*10))")])])])])]),a._v(" "),t("h3",{attrs:{id:"enabling-the-array-arithmetic-mode-globally"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-the-array-arithmetic-mode-globally"}},[a._v("#")]),a._v(" Enabling the array arithmetic mode globally")]),a._v(" "),t("p",[a._v("To enable the array arithmetic mode by default, everywhere in your HyperFormula instance:")]),a._v(" "),t("ul",[t("li",[a._v("In your HyperFormula "),t("RouterLink",{attrs:{to:"/api/interfaces/configparams.html#usearrayarithmetic"}},[a._v("configuration")]),a._v(", set the "),t("code",[a._v("useArrayArithmetic")]),a._v(" option to "),t("code",[a._v("true")]),a._v(".")],1)]),a._v(" "),t("p",[a._v("With the array arithmetic mode enabled globally, you can operate on arrays without using the "),t("code",[a._v("ARRAYFORMULA")]),a._v(" function:")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=A2:A5*B2:B5\n\nISEVEN(A2:A5*10)\n")])])]),t("h2",{attrs:{id:"array-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-features"}},[a._v("#")]),a._v(" Array features")]),a._v(" "),t("p",[a._v("Thanks to HyperFormula's built-in array features, you can:")]),a._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#operating-on-arrays"}},[a._v("Operate on arrays")]),a._v(" just like on "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")])]),a._v(" "),t("li",[t("a",{attrs:{href:"#passing-arrays-to-scalar-functions-vectorization"}},[a._v("Pass arrays to functions")]),a._v(" that accept "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")])]),a._v(" "),t("li",[t("a",{attrs:{href:"#broadcasting"}},[a._v("Broadcast")]),a._v(" smaller input arrays across larger output areas")])]),a._v(" "),t("p",[a._v("You can also:")]),a._v(" "),t("ul",[t("li",[a._v("Use the "),t("code",[a._v("FILTER")]),a._v(" function to "),t("a",{attrs:{href:"#filtering-an-array"}},[a._v("filter an array")]),a._v(", based on boolean arrays")]),a._v(" "),t("li",[a._v("Use the "),t("code",[a._v("ARRAY_CONSTRAIN")]),a._v(" function to "),t("a",{attrs:{href:"#constraining-an-array-s-size"}},[a._v("constrain an array's size")])])]),a._v(" "),t("h3",{attrs:{id:"operating-on-arrays"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#operating-on-arrays"}},[a._v("#")]),a._v(" Operating on arrays")]),a._v(" "),t("p",[a._v("You can operate on arrays just like on single values.")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, each output array value is the result of your operation on the corresponding input array value.")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(A2:A5*B2:B5)\n\n// calculates:\n// =A2*B2\n// =A3*B3\n// =A4*B4\n// =A5*B5\n")])])]),t("h3",{attrs:{id:"passing-arrays-to-scalar-functions-vectorization"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#passing-arrays-to-scalar-functions-vectorization"}},[a._v("#")]),a._v(" Passing arrays to scalar functions (vectorization)")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, HyperFormula automatically "),t("em",[a._v("vectorizes")]),a._v(" most functions.")]),a._v(" "),t("p",[a._v("As a consequence of that, you can pass arrays to functions that would normally accept "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalars")]),a._v(". The result would also be an array.")]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5))\n\n// calculates:\n// =ISEVEN(A2)\n// =ISEVEN(A3)\n// =ISEVEN(A4)\n// =ISEVEN(A5)\n")])])]),t("h3",{attrs:{id:"broadcasting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#broadcasting"}},[a._v("#")]),a._v(" Broadcasting")]),a._v(" "),t("p",[a._v("If an input array has a dimension of "),t("code",[a._v("1")]),a._v(', it\'s automatically repeated ("broadcast") on that dimension to match the size of the output.')]),a._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("=ARRAYFORMULA(ISEVEN(A2:A5*B2))\n\n// calculates:\n// =ISEVEN(A2*B2)\n// =ISEVEN(A3*B2)\n// =ISEVEN(A4*B2)\n// =ISEVEN(A5*B2)\n")])])]),t("h3",{attrs:{id:"filtering-an-array"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#filtering-an-array"}},[a._v("#")]),a._v(" Filtering an array")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, you can filter an array, based on boolean arrays, using the "),t("code",[a._v("FILTER")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("FILTER(your_array, BoolArray1[, BoolArray2[, ...]]")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(FILTER(A2:A5*10), {1, 0, 0, 1})")])])])])]),a._v(" "),t("h3",{attrs:{id:"constraining-an-array-s-size"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#constraining-an-array-s-size"}},[a._v("#")]),a._v(" Constraining an array's size")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, you can constrain the size of the output array, using the "),t("code",[a._v("ARRAY_CONSTRAIN")]),a._v(" function:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Syntax")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Example")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("ARRAY_CONSTRAIN(your_array,height,width)")])]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("=ARRAYFORMULA(ARRAY_CONSTRAIN(A2:E5, 2, 2))")])])])])]),a._v(" "),t("p",[a._v("If your specified output array size is smaller than the input array size, only the corresponding top-left cells of the input array are taken into account.")]),a._v(" "),t("p",[a._v("If your specified output array size is larger or equal to the input array size, no change is made.")]),a._v(" "),t("h2",{attrs:{id:"array-rules"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#array-rules"}},[a._v("#")]),a._v(" Array rules")]),a._v(" "),t("h3",{attrs:{id:"with-the-array-arithmetic-mode-enabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-the-array-arithmetic-mode-enabled"}},[a._v("#")]),a._v(" With the array arithmetic mode enabled")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is enabled, and you pass an array to a "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalar")]),a._v(" function, the following rules apply:")]),a._v(" "),t("ul",[t("li",[a._v("Array dimensions need to be consistent (e.g., every row needs to be of the same length).")]),a._v(" "),t("li",[a._v("If an input array value is missing (due to a difference in dimensions), the corresponding output array value is "),t("code",[a._v("#N/A")]),a._v(".")]),a._v(" "),t("li",[a._v("If a cell evaluates to an array, the array values are spilled into neighboring cells (unless the neighboring cells are already filled)."),t("br"),a._v("This behavior doesn't apply to ranges, which return the "),t("code",[a._v("#VALUE!")]),a._v(" error in this case.")]),a._v(" "),t("li",[a._v("If one of input array dimensions is "),t("code",[a._v("1")]),a._v(" ("),t("code",[a._v("1")]),a._v("x"),t("code",[a._v("n")]),a._v(" or "),t("code",[a._v("n")]),a._v("x"),t("code",[a._v("1")]),a._v("), the array is repeated, to match the output array dimensions.")])]),a._v(" "),t("h3",{attrs:{id:"with-the-array-arithmetic-mode-disabled"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-the-array-arithmetic-mode-disabled"}},[a._v("#")]),a._v(" With the array arithmetic mode disabled")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is disabled, and you pass an array to a "),t("a",{attrs:{href:"#about-arrays"}},[a._v("scalar")]),a._v(" function, the array is reduced to 1 element (usually the array's top-left value).")]),a._v(" "),t("p",[a._v("When the "),t("a",{attrs:{href:"#array-arithmetic-mode"}},[a._v("array arithmetic mode")]),a._v(" is disabled, and you operate on a range of width/height equal to "),t("code",[a._v("1")]),a._v(", the behavior depends on your array formula's location:")]),a._v(" "),t("table",[t("thead",[t("tr",[t("th",{staticStyle:{"text-align":"left"}},[a._v("Your array formula's location")]),a._v(" "),t("th",{staticStyle:{"text-align":"left"}},[a._v("Behavior")])])]),a._v(" "),t("tbody",[t("tr",[t("td",{staticStyle:{"text-align":"left"}},[a._v("In the same row as as one of the range's elements")]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[a._v("Only that particular element is taken.")])]),a._v(" "),t("tr",[t("td",{staticStyle:{"text-align":"left"}},[a._v("Any other cell")]),a._v(" "),t("td",{staticStyle:{"text-align":"left"}},[t("code",[a._v("#VALUE!")]),a._v(" error")])])])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/37.860c98d1.js b/assets/js/36.87874ebe.js similarity index 98% rename from assets/js/37.860c98d1.js rename to assets/js/36.87874ebe.js index 2dea014f5..58d76d03a 100644 --- a/assets/js/37.860c98d1.js +++ b/assets/js/36.87874ebe.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{330: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:"500px",border:"0","border-radius":"4px",overflow:"hidden"},attrs:{src:"https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.6.x/basic-operations?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview",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:"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 diff --git a/assets/js/38.9afba4e9.js b/assets/js/37.a20420db.js similarity index 91% rename from assets/js/38.9afba4e9.js rename to assets/js/37.a20420db.js index 1a8fd5193..4e5123e03 100644 --- a/assets/js/38.9afba4e9.js +++ b/assets/js/37.a20420db.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{331: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 8f4ac6b0f..c4598d0fa 100644 --- a/guide/arrays.html +++ b/guide/arrays.html @@ -3,7 +3,7 @@ - Array formulas | HyperFormula (v2.6.2) + Array formulas | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/basic-operations.html b/guide/basic-operations.html index ad7d41672..9d77b3c49 100644 --- a/guide/basic-operations.html +++ b/guide/basic-operations.html @@ -3,7 +3,7 @@ - Basic operations | HyperFormula (v2.6.2) + Basic operations | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/basic-usage.html b/guide/basic-usage.html index 7bc2df873..2338e3ee8 100644 --- a/guide/basic-usage.html +++ b/guide/basic-usage.html @@ -3,7 +3,7 @@ - Basic usage | HyperFormula (v2.6.2) + Basic usage | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/batch-operations.html b/guide/batch-operations.html index 398959548..f070b0eda 100644 --- a/guide/batch-operations.html +++ b/guide/batch-operations.html @@ -3,7 +3,7 @@ - Batch operations | HyperFormula (v2.6.2) + Batch operations | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/branding.html b/guide/branding.html index 319e0d435..4b3043eaa 100644 --- a/guide/branding.html +++ b/guide/branding.html @@ -3,7 +3,7 @@ - Branding | HyperFormula (v2.6.2) + Branding | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/building.html b/guide/building.html index 029e2ff66..2ae95665e 100644 --- a/guide/building.html +++ b/guide/building.html @@ -3,7 +3,7 @@ - Building | HyperFormula (v2.6.2) + Building | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/built-in-functions.html b/guide/built-in-functions.html index 679a25843..6e085f68d 100644 --- a/guide/built-in-functions.html +++ b/guide/built-in-functions.html @@ -3,7 +3,7 @@ - Built-in functions | HyperFormula (v2.6.2) + Built-in functions | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/cell-references.html b/guide/cell-references.html index f7a3dd14d..d10ea10b7 100644 --- a/guide/cell-references.html +++ b/guide/cell-references.html @@ -3,7 +3,7 @@ - Cell references | HyperFormula (v2.6.2) + Cell references | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/client-side-installation.html b/guide/client-side-installation.html index 3c2ac096c..ad95b70d8 100644 --- a/guide/client-side-installation.html +++ b/guide/client-side-installation.html @@ -3,7 +3,7 @@ - Client-side installation | HyperFormula (v2.6.2) + Client-side installation | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/clipboard-operations.html b/guide/clipboard-operations.html index b448791a2..89820e882 100644 --- a/guide/clipboard-operations.html +++ b/guide/clipboard-operations.html @@ -3,7 +3,7 @@ - Clipboard operations | HyperFormula (v2.6.2) + Clipboard operations | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/code-of-conduct.html b/guide/code-of-conduct.html index 767699c8b..10c594a46 100644 --- a/guide/code-of-conduct.html +++ b/guide/code-of-conduct.html @@ -3,7 +3,7 @@ - Code of conduct | HyperFormula (v2.6.2) + Code of conduct | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/compatibility-with-google-sheets.html b/guide/compatibility-with-google-sheets.html index 16c87422b..de042cada 100644 --- a/guide/compatibility-with-google-sheets.html +++ b/guide/compatibility-with-google-sheets.html @@ -3,7 +3,7 @@ - Compatibility with Google Sheets | HyperFormula (v2.6.2) + Compatibility with Google Sheets | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/compatibility-with-microsoft-excel.html b/guide/compatibility-with-microsoft-excel.html index 244d79541..dd2aac098 100644 --- a/guide/compatibility-with-microsoft-excel.html +++ b/guide/compatibility-with-microsoft-excel.html @@ -3,7 +3,7 @@ - Compatibility with Microsoft Excel | HyperFormula (v2.6.2) + Compatibility with Microsoft Excel | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/configuration-options.html b/guide/configuration-options.html index a19847bd4..70d8fbac1 100644 --- a/guide/configuration-options.html +++ b/guide/configuration-options.html @@ -3,7 +3,7 @@ - Configuration options | HyperFormula (v2.6.2) + Configuration options | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/contact.html b/guide/contact.html index a6ec2e91e..f22704fc6 100644 --- a/guide/contact.html +++ b/guide/contact.html @@ -3,7 +3,7 @@ - Contact | HyperFormula (v2.6.2) + Contact | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/contributing.html b/guide/contributing.html index ae74858bc..8d48d26de 100644 --- a/guide/contributing.html +++ b/guide/contributing.html @@ -3,7 +3,7 @@ - Contributing | HyperFormula (v2.6.2) + Contributing | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/custom-functions.html b/guide/custom-functions.html index 64696ab4e..0a7a977df 100644 --- a/guide/custom-functions.html +++ b/guide/custom-functions.html @@ -3,7 +3,7 @@ - Custom functions | HyperFormula (v2.6.2) + Custom functions | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/date-and-time-handling.html b/guide/date-and-time-handling.html index f2bc05a67..be944b29b 100644 --- a/guide/date-and-time-handling.html +++ b/guide/date-and-time-handling.html @@ -3,7 +3,7 @@ - Date and time handling | HyperFormula (v2.6.2) + Date and time handling | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/demo.html b/guide/demo.html index 39166fb4c..eae18d7e0 100644 --- a/guide/demo.html +++ b/guide/demo.html @@ -3,7 +3,7 @@ - Demo | HyperFormula (v2.6.2) + Demo | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/dependencies.html b/guide/dependencies.html index cc2658270..7dc102df5 100644 --- a/guide/dependencies.html +++ b/guide/dependencies.html @@ -3,7 +3,7 @@ - Dependencies | HyperFormula (v2.6.2) + Dependencies | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/dependency-graph.html b/guide/dependency-graph.html index 4c9730a0a..22149ea96 100644 --- a/guide/dependency-graph.html +++ b/guide/dependency-graph.html @@ -3,7 +3,7 @@ - Dependency graph | HyperFormula (v2.6.2) + Dependency graph | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/file-import.html b/guide/file-import.html index aee305d8b..1d8b3b80b 100644 --- a/guide/file-import.html +++ b/guide/file-import.html @@ -3,7 +3,7 @@ - File import | HyperFormula (v2.6.2) + File import | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/i18n-features.html b/guide/i18n-features.html index 6b47ff258..e6752d821 100644 --- a/guide/i18n-features.html +++ b/guide/i18n-features.html @@ -3,7 +3,7 @@ - Internationalization features | HyperFormula (v2.6.2) + Internationalization features | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/integration-with-angular.html b/guide/integration-with-angular.html index f2c448e30..21c306b95 100644 --- a/guide/integration-with-angular.html +++ b/guide/integration-with-angular.html @@ -3,7 +3,7 @@ - Integration with Angular | HyperFormula (v2.6.2) + Integration with Angular | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/integration-with-react.html b/guide/integration-with-react.html index 228af1798..4f4d0ba15 100644 --- a/guide/integration-with-react.html +++ b/guide/integration-with-react.html @@ -3,7 +3,7 @@ - Integration with React | HyperFormula (v2.6.2) + Integration with React | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/integration-with-svelte.html b/guide/integration-with-svelte.html index 774721318..aae80e926 100644 --- a/guide/integration-with-svelte.html +++ b/guide/integration-with-svelte.html @@ -3,7 +3,7 @@ - Integration with Svelte | HyperFormula (v2.6.2) + Integration with Svelte | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/integration-with-vue.html b/guide/integration-with-vue.html index 6f5ae668f..c29d2bbc3 100644 --- a/guide/integration-with-vue.html +++ b/guide/integration-with-vue.html @@ -3,7 +3,7 @@ - Integration with Vue | HyperFormula (v2.6.2) + Integration with Vue | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/key-concepts.html b/guide/key-concepts.html index c32a8e2b2..f1adf1ec7 100644 --- a/guide/key-concepts.html +++ b/guide/key-concepts.html @@ -3,7 +3,7 @@ - Key concepts | HyperFormula (v2.6.2) + Key concepts | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/known-limitations.html b/guide/known-limitations.html index 61ecb1303..6448e69b0 100644 --- a/guide/known-limitations.html +++ b/guide/known-limitations.html @@ -3,7 +3,7 @@ - Known limitations | HyperFormula (v2.6.2) + Known limitations | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/license-key.html b/guide/license-key.html index 16a6d512f..f4be4934c 100644 --- a/guide/license-key.html +++ b/guide/license-key.html @@ -3,7 +3,7 @@ - License key | HyperFormula (v2.6.2) + License key | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/licensing.html b/guide/licensing.html index 914057eb1..a418453db 100644 --- a/guide/licensing.html +++ b/guide/licensing.html @@ -3,7 +3,7 @@ - Licensing | HyperFormula (v2.6.2) + Licensing | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/list-of-differences.html b/guide/list-of-differences.html index c19bd9484..25dce1ae4 100644 --- a/guide/list-of-differences.html +++ b/guide/list-of-differences.html @@ -3,7 +3,7 @@ - List of differences with other spreadsheets | HyperFormula (v2.6.2) + List of differences with other spreadsheets | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/localizing-functions.html b/guide/localizing-functions.html index 540479c18..064d26d60 100644 --- a/guide/localizing-functions.html +++ b/guide/localizing-functions.html @@ -3,7 +3,7 @@ - Localizing functions | HyperFormula (v2.6.2) + Localizing functions | HyperFormula (v2.7.0) + \ 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 05ac74343..cfc95e7a8 100644 --- a/guide/migration-from-0.6-to-1.0.html +++ b/guide/migration-from-0.6-to-1.0.html @@ -3,7 +3,7 @@ - Migrating from 0.6 to 1.0 | HyperFormula (v2.6.2) + Migrating from 0.6 to 1.0 | HyperFormula (v2.7.0) + \ 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 d68f8e983..a0b7e185c 100644 --- a/guide/migration-from-1.0-to-2.0.html +++ b/guide/migration-from-1.0-to-2.0.html @@ -3,7 +3,7 @@ - Migrating from 1.x to 2.0 | HyperFormula (v2.6.2) + Migrating from 1.x to 2.0 | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/named-expressions.html b/guide/named-expressions.html index 14bdbb9e2..1be93b323 100644 --- a/guide/named-expressions.html +++ b/guide/named-expressions.html @@ -3,7 +3,7 @@ - Named expressions | HyperFormula (v2.6.2) + Named expressions | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/order-of-precendece.html b/guide/order-of-precendece.html index 71567a13b..064664f07 100644 --- a/guide/order-of-precendece.html +++ b/guide/order-of-precendece.html @@ -3,7 +3,7 @@ - Order of precedence | HyperFormula (v2.6.2) + Order of precedence | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/performance.html b/guide/performance.html index 54d12f56c..52b8d1d5c 100644 --- a/guide/performance.html +++ b/guide/performance.html @@ -3,7 +3,7 @@ - Performance | HyperFormula (v2.6.2) + Performance | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/release-notes.html b/guide/release-notes.html index 6d1e08e8c..847752984 100644 --- a/guide/release-notes.html +++ b/guide/release-notes.html @@ -3,7 +3,7 @@ - Release notes | HyperFormula (v2.6.2) + Release notes | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/server-side-installation.html b/guide/server-side-installation.html index 326466aa5..af3ceab3a 100644 --- a/guide/server-side-installation.html +++ b/guide/server-side-installation.html @@ -3,7 +3,7 @@ - Server-side installation | HyperFormula (v2.6.2) + Server-side installation | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/sorting-data.html b/guide/sorting-data.html index 53ef7409a..c6692bc30 100644 --- a/guide/sorting-data.html +++ b/guide/sorting-data.html @@ -3,7 +3,7 @@ - Sorting data | HyperFormula (v2.6.2) + Sorting data | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/specifications-and-limits.html b/guide/specifications-and-limits.html index 2e9431ae3..6489716c1 100644 --- a/guide/specifications-and-limits.html +++ b/guide/specifications-and-limits.html @@ -3,7 +3,7 @@ - Specifications and limits | HyperFormula (v2.6.2) + Specifications and limits | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/support.html b/guide/support.html index 2e3b7afef..78c87691f 100644 --- a/guide/support.html +++ b/guide/support.html @@ -3,7 +3,7 @@ - Support | HyperFormula (v2.6.2) + Support | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/supported-browsers.html b/guide/supported-browsers.html index c20c756f7..a53f9cc16 100644 --- a/guide/supported-browsers.html +++ b/guide/supported-browsers.html @@ -3,7 +3,7 @@ - Supported browsers | HyperFormula (v2.6.2) + Supported browsers | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/types-of-errors.html b/guide/types-of-errors.html index 05daccb63..2c06da723 100644 --- a/guide/types-of-errors.html +++ b/guide/types-of-errors.html @@ -3,7 +3,7 @@ - Types of errors | HyperFormula (v2.6.2) + Types of errors | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/types-of-operators.html b/guide/types-of-operators.html index 5e2c89dac..72b421ed9 100644 --- a/guide/types-of-operators.html +++ b/guide/types-of-operators.html @@ -3,7 +3,7 @@ - Types of operators | HyperFormula (v2.6.2) + Types of operators | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/types-of-values.html b/guide/types-of-values.html index 64e6fdc59..20e60e82f 100644 --- a/guide/types-of-values.html +++ b/guide/types-of-values.html @@ -3,7 +3,7 @@ - Types of values | HyperFormula (v2.6.2) + Types of values | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/undo-redo.html b/guide/undo-redo.html index 16854014d..4c7eee89a 100644 --- a/guide/undo-redo.html +++ b/guide/undo-redo.html @@ -3,7 +3,7 @@ - Undo-redo | HyperFormula (v2.6.2) + Undo-redo | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/guide/volatile-functions.html b/guide/volatile-functions.html index c7d2529b5..489f77aa5 100644 --- a/guide/volatile-functions.html +++ b/guide/volatile-functions.html @@ -3,7 +3,7 @@ - Volatile functions | HyperFormula (v2.6.2) + Volatile functions | HyperFormula (v2.7.0) + \ No newline at end of file diff --git a/index.html b/index.html index 6fc82a2c6..95a01b063 100644 --- a/index.html +++ b/index.html @@ -3,7 +3,7 @@ - HyperFormula guide | HyperFormula (v2.6.2) + HyperFormula (v2.7.0) + \ No newline at end of file