diff --git a/404.html b/404.html index 26f51da41..cded426ea 100644 --- a/404.html +++ b/404.html @@ -19,16 +19,16 @@ - + -

404

Looks like we've got some broken links.
+ - + \ No newline at end of file diff --git a/api-template.html b/api-template.html index b4b9141fa..f5e9618a1 100644 --- a/api-template.html +++ b/api-template.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference
GitHub - (opens new window)

Welcome to the HyperFormula v2.6.0 API!

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

Current build: 19/09/2023 11:06:12

# API reference index

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

# HyperFormula

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

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

const sheetData = [
+     (opens new window)    
 
Welcome to the HyperFormula v2.6.0 API!
 
The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.
 
Current build: 26/09/2023 14:21:35
 
# API reference index
 
The following sections explain shortly what can be found in the left sidebar navigation menu.
 
# HyperFormula
 
This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.
 
The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:
 
const sheetData = [
   ['0', '=SUM(1, 2, 3)', '52'],
   ['=SUM(A1:C1)', '', '=A1'],
   ['2', '=SUM(A1:C1)', '91'],
@@ -80,6 +80,6 @@
   }
 }
- + \ No newline at end of file diff --git a/api/classes/config.html b/api/classes/config.html index cd2598601..5f984bd00 100644 --- a/api/classes/config.html +++ b/api/classes/config.html @@ -19,7 +19,7 @@ - + @@ -38,12 +38,12 @@ API Reference
GitHub - (opens new window)

# 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. + (opens new window)

# 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. +(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

- +E.g. for timeFormats = ['hh:mm:ss.sss'], valid time strings include:

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)

+ \ No newline at end of file diff --git a/api/classes/emitter.html b/api/classes/emitter.html index 1c7aa74be..db565e7b7 100644 --- a/api/classes/emitter.html +++ b/api/classes/emitter.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# Emitter Class

# Methods

# emit

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

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

Type parameters:

▪ Event: keyof Listeners

Parameters:

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

Returns: this

# off

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

Parameters:

Name Type
event string
callback? Function

Returns: this

# on

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

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

# once

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

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

- + (opens new window)

# Emitter Class

# Methods

# emit

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

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

Type parameters:

▪ Event: keyof Listeners

Parameters:

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

Returns: this

# off

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

Parameters:

Name Type
event string
callback? Function

Returns: this

# on

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

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

# once

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

Parameters:

Name Type
event string
callback Function
ctx? any

Returns: this

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

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

# Static Properties

# buildDate Static

▪ buildDate: string = '19/09/2023 11:06:12'

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

Latest build date.

# languages Static

▪ languages: Record‹string, RawTranslationPackage›

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

Contains all available languages to use in registerLanguage.

# releaseDate Static

▪ releaseDate: string = '19/09/2023'

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

A release date.

# version Static

▪ version: string = '2.6.0'

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

Version of the HyperFormula.

# Static Accessors

# defaultConfig Static

• get defaultConfig(): ConfigParams

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

Returns all of HyperFormula's default configuration options.

example

// returns all default configuration options
+errors, so they can be correctly handled.
 
# Static Properties
 
# buildDate Static
 
▪ buildDate: string = '26/09/2023 14:21:35'
 
Defined in src/HyperFormula.ts:100 (opens new window)
 
Latest build date.
 
 
# languages Static
 
▪ languages: Record‹string, RawTranslationPackage›
 
Defined in src/HyperFormula.ts:114 (opens new window)
 
Contains all available languages to use in registerLanguage.
 
 
# releaseDate Static
 
▪ releaseDate: string = '19/09/2023'
 
Defined in src/HyperFormula.ts:107 (opens new window)
 
A release date.
 
 
# version Static
 
▪ version: string = '2.6.0'
 
Defined in src/HyperFormula.ts:93 (opens new window)
 
Version of the HyperFormula.
 
# Static Accessors
 
# defaultConfig Static
 
• get defaultConfig(): ConfigParams
 
Defined in src/HyperFormula.ts:153 (opens new window)
 
Returns all of HyperFormula's default configuration options.
 
example
 
// returns all default configuration options
 const defaultConfig = HyperFormula.defaultConfig;
-
category Static Accessors
 
Returns: ConfigParams
 
# Factories
 
# buildEmpty Static
 
▸ buildEmpty(configInput: Partial‹ConfigParams›, namedExpressions: SerializedNamedExpression[]): HyperFormula
 
Defined in src/HyperFormula.ts:325 (opens new window)
 
Builds an empty engine instance.
+

category Static Accessors

Returns: ConfigParams

# Factories

# buildEmpty Static

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

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

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

example

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

Parameters:

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

Returns: HyperFormula

# buildFromArray Static

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

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

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

Parameters:

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

Returns: HyperFormula

# buildFromArray Static

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

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

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

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

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

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

example

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

Parameters:

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

Returns: HyperFormula

# buildFromSheets Static

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

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

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

Parameters:

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

Returns: HyperFormula

# buildFromSheets Static

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

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

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

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

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

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

example

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

Parameters:

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

Returns: HyperFormula

# Instance

# destroy

▸ destroy(): void

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

Destroys instance of HyperFormula.

example

// destroys the instance
+

Parameters:

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

Returns: HyperFormula

# Instance

# destroy

▸ destroy(): void

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

Destroys instance of HyperFormula.

example

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

Returns: void

# getConfig

▸ getConfig(): ConfigParams

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

Returns current configuration of the engine instance.

example

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

Returns: void

# getConfig

▸ getConfig(): ConfigParams

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

Returns current configuration of the engine instance.

example

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

Returns: ConfigParams

# rebuildAndRecalculate

▸ rebuildAndRecalculate(): void

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

Rebuilds the HyperFormula instance preserving the current sheets data.

example

hfInstance.rebuildAndRecalculate();
-

Returns: void

# updateConfig

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: ConfigParams

# rebuildAndRecalculate

▸ rebuildAndRecalculate(): void

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

Rebuilds the HyperFormula instance preserving the current sheets data.

example

hfInstance.rebuildAndRecalculate();
+

Returns: void

# updateConfig

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

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

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

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

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

example

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

Parameters:

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

Returns: void

# Sheets

# addSheet

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

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

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

fires sheetAdded after the sheet was added

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

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

Returns: void

# Sheets

# addSheet

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

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

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

fires sheetAdded after the sheet was added

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

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

example

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

Parameters:

Name Type
sheetName? undefined | string

Returns: string

# clearSheet

▸ clearSheet(sheetId: number): ExportedChange[]

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type
sheetName? undefined | string

Returns: string

# clearSheet

▸ clearSheet(sheetId: number): ExportedChange[]

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# countSheets

▸ countSheets(): number

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

Returns the number of existing sheets.

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# countSheets

▸ countSheets(): number

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

Returns the number of existing sheets.

example

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

Returns: number

# doesSheetExist

▸ doesSheetExist(sheetName: string): boolean

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Returns: number

# doesSheetExist

▸ doesSheetExist(sheetName: string): boolean

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

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

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

example

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

Parameters:

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

Returns: boolean

# getAllSheetsDimensions

▸ getAllSheetsDimensions(): Record‹string, SheetDimensions›

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

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

Returns: boolean

# getAllSheetsDimensions

▸ getAllSheetsDimensions(): Record‹string, SheetDimensions›

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

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

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

example

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

Returns: Record‹string, SheetDimensions›

# getAllSheetsFormulas

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: Record‹string, SheetDimensions›

# getAllSheetsFormulas

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

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

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

example

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

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

# getAllSheetsSerialized

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
+

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

# getAllSheetsSerialized

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

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

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

# getAllSheetsValues

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

const hfInstance = HyperFormula.buildFromArray([
+

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

# getAllSheetsValues

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

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

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

# getSheetDimensions

▸ getSheetDimensions(sheetId: number): SheetDimensions

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

Returns dimensions of a specified sheet. +

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

# getSheetDimensions

▸ getSheetDimensions(sheetId: number): SheetDimensions

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

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

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: SheetDimensions

# getSheetFormulas

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: SheetDimensions

# getSheetFormulas

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

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

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

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: (string | undefined)[][]

# getSheetId

▸ getSheetId(sheetName: string): number | undefined

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: (string | undefined)[][]

# getSheetId

▸ getSheetId(sheetName: string): number | undefined

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

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

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

example

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

Parameters:

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

Returns: number | undefined

# getSheetName

▸ getSheetName(sheetId: number): string | undefined

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

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

Returns: number | undefined

# getSheetName

▸ getSheetName(sheetId: number): string | undefined

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

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

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

example

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

Parameters:

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

Returns: string | undefined

# getSheetNames

▸ getSheetNames(): string[]

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

List all sheet names. +

Parameters:

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

Returns: string | undefined

# getSheetNames

▸ getSheetNames(): string[]

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

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

example

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

Returns: string[]

# getSheetSerialized

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

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: string[]

# getSheetSerialized

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

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: RawCellContent[][]

# getSheetValues

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

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

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: RawCellContent[][]

# getSheetValues

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

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

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: CellValue[][]

# isItPossibleToAddSheet

▸ isItPossibleToAddSheet(sheetName: string): boolean

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

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

Parameters:

Name Type Description
sheetId number sheet ID number

Returns: CellValue[][]

# isItPossibleToAddSheet

▸ isItPossibleToAddSheet(sheetName: string): boolean

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

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

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

example

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

Parameters:

Name Type Description
sheetName string sheet name, case-insensitive

Returns: boolean

# isItPossibleToClearSheet

▸ isItPossibleToClearSheet(sheetId: number): boolean

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

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

Parameters:

Name Type Description
sheetName string sheet name, case-insensitive

Returns: boolean

# isItPossibleToClearSheet

▸ isItPossibleToClearSheet(sheetId: number): boolean

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

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRemoveSheet

▸ isItPossibleToRemoveSheet(sheetId: number): boolean

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

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

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRemoveSheet

▸ isItPossibleToRemoveSheet(sheetId: number): boolean

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

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRenameSheet

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

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

Returns information whether it is possible to rename sheet. +

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: boolean

# isItPossibleToRenameSheet

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToReplaceSheetContent

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

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

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

Parameters:

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

Returns: boolean

# isItPossibleToReplaceSheetContent

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# removeSheet

▸ removeSheet(sheetId: number): ExportedChange[]

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

Removes a sheet

Note that this method may trigger dependency graph recalculation.

fires sheetRemoved after the sheet was removed

fires valuesUpdated if recalculation was triggered by this change

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

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

Returns: boolean

# removeSheet

▸ removeSheet(sheetId: number): ExportedChange[]

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

Removes a sheet

Note that this method may trigger dependency graph recalculation.

fires sheetRemoved after the sheet was removed

fires valuesUpdated if recalculation was triggered by this change

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

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

example

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

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# renameSheet

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

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

Renames a specified sheet.

fires sheetRenamed after the sheet was renamed

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
sheetId number sheet ID.

Returns: ExportedChange[]

# renameSheet

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

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

Renames a specified sheet.

fires sheetRenamed after the sheet was renamed

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

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

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

example

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

Parameters:

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

Returns: void

# setSheetContent

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

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

Replaces the sheet content with new values.

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

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

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

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

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

Returns: void

# setSheetContent

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

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

Replaces the sheet content with new values.

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# Ranges

# getFillRangeData

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# Ranges

# getFillRangeData

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

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

example

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

Parameters:

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

Returns: RawCellContent[][]

# getRangeFormulas

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

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

Returns cell formulas in given range.

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: RawCellContent[][]

# getRangeFormulas

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

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

Returns cell formulas in given range.

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

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

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

example

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

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: (string | undefined)[][]

# getRangeSerialized

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

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

Returns serialized cells in given range.

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: (string | undefined)[][]

# getRangeSerialized

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

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

Returns serialized cells in given range.

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

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

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

example

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

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: RawCellContent[][]

# getRangeValues

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

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: RawCellContent[][]

# getRangeValues

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

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

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

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

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

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

example

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

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: CellValue[][]

# Rows

# addRows

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

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

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

Parameters:

Name Type Description
source SimpleCellRange rectangular range

Returns: CellValue[][]

# Rows

# addRows

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# isItPossibleToAddRows

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

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

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

Parameters:

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

Returns: ExportedChange[]

# isItPossibleToAddRows

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToMoveRows

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

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

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

Parameters:

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

Returns: boolean

# isItPossibleToMoveRows

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToRemoveRows

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

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

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

Parameters:

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

Returns: boolean

# isItPossibleToRemoveRows

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToSetRowOrder

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# isItPossibleToSetRowOrder

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToSwapRowIndexes

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# isItPossibleToSwapRowIndexes

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# moveRows

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# moveRows

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# removeRows

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

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

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

Parameters:

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

Returns: ExportedChange[]

# removeRows

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# setRowOrder

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

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

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

Parameters:

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

Returns: ExportedChange[]

# setRowOrder

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

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

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

Note: This method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# swapRowIndexes

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# swapRowIndexes

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# Columns

# addColumns

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

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

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

Parameters:

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

Returns: ExportedChange[]

# Columns

# addColumns

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# isItPossibleToAddColumns

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

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

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

Parameters:

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

Returns: ExportedChange[]

# isItPossibleToAddColumns

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToMoveColumns

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

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

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

Parameters:

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

Returns: boolean

# isItPossibleToMoveColumns

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToRemoveColumns

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

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

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

Parameters:

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

Returns: boolean

# isItPossibleToRemoveColumns

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToSetColumnOrder

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# isItPossibleToSetColumnOrder

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToSwapColumnIndexes

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

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

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

fires valuesUpdated if recalculation was triggered by this change

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# isItPossibleToSwapColumnIndexes

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

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

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

fires valuesUpdated if recalculation was triggered by this change

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

example

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

Parameters:

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

Returns: boolean

# moveColumns

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# moveColumns

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# removeColumns

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

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

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

Parameters:

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

Returns: ExportedChange[]

# removeColumns

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# setColumnOrder

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

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

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

Parameters:

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

Returns: ExportedChange[]

# setColumnOrder

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

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

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

Note: This method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# swapColumnIndexes

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# swapColumnIndexes

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# Cells

# doesCellHaveFormula

▸ doesCellHaveFormula(cellAddress: SimpleCellAddress): boolean

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

Returns true if the specified cell contains a formula. +

Parameters:

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

Returns: ExportedChange[]

# Cells

# doesCellHaveFormula

▸ doesCellHaveFormula(cellAddress: SimpleCellAddress): boolean

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# doesCellHaveSimpleValue

▸ doesCellHaveSimpleValue(cellAddress: SimpleCellAddress): boolean

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# doesCellHaveSimpleValue

▸ doesCellHaveSimpleValue(cellAddress: SimpleCellAddress): boolean

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# getCellFormula

▸ getCellFormula(cellAddress: SimpleCellAddress): string | undefined

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# getCellFormula

▸ getCellFormula(cellAddress: SimpleCellAddress): string | undefined

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

▸ getCellHyperlink(cellAddress: SimpleCellAddress): string | undefined

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

▸ getCellHyperlink(cellAddress: SimpleCellAddress): string | undefined

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

# getCellSerialized

▸ getCellSerialized(cellAddress: SimpleCellAddress): RawCellContent

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: string | undefined

# getCellSerialized

▸ getCellSerialized(cellAddress: SimpleCellAddress): RawCellContent

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: RawCellContent

# getCellType

▸ getCellType(cellAddress: SimpleCellAddress): CellType

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: RawCellContent

# getCellType

▸ getCellType(cellAddress: SimpleCellAddress): CellType

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellType

# getCellValue

▸ getCellValue(cellAddress: SimpleCellAddress): CellValue

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

Returns the cell value of a given address. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellType

# getCellValue

▸ getCellValue(cellAddress: SimpleCellAddress): CellValue

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

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValue

# getCellValueDetailedType

▸ getCellValueDetailedType(cellAddress: SimpleCellAddress): CellValueDetailedType

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValue

# getCellValueDetailedType

▸ getCellValueDetailedType(cellAddress: SimpleCellAddress): CellValueDetailedType

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueDetailedType

# getCellValueFormat

▸ getCellValueFormat(cellAddress: SimpleCellAddress): FormatInfo

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueDetailedType

# getCellValueFormat

▸ getCellValueFormat(cellAddress: SimpleCellAddress): FormatInfo

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: FormatInfo

# getCellValueType

▸ getCellValueType(cellAddress: SimpleCellAddress): CellValueType

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: FormatInfo

# getCellValueType

▸ getCellValueType(cellAddress: SimpleCellAddress): CellValueType

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

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

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

throws [[EvaluationSuspendedError]] when the evaluation is suspended

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueType

# isCellEmpty

▸ isCellEmpty(cellAddress: SimpleCellAddress): boolean

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

Returnstrue if the specified cell is empty. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: CellValueType

# isCellEmpty

▸ isCellEmpty(cellAddress: SimpleCellAddress): boolean

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isCellPartOfArray

▸ isCellPartOfArray(cellAddress: SimpleCellAddress): boolean

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isCellPartOfArray

▸ isCellPartOfArray(cellAddress: SimpleCellAddress): boolean

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

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

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

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

example

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isItPossibleToMoveCells

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

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

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

Parameters:

Name Type Description
cellAddress SimpleCellAddress cell coordinates

Returns: boolean

# isItPossibleToMoveCells

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

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# isItPossibleToSetCellContents

▸ isItPossibleToSetCellContents(address: SimpleCellAddress | SimpleCellRange): boolean

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

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

Parameters:

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

Returns: boolean

# isItPossibleToSetCellContents

▸ isItPossibleToSetCellContents(address: SimpleCellAddress | SimpleCellRange): boolean

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

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

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

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

example

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

Parameters:

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

Returns: boolean

# moveCells

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: boolean

# moveCells

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# setCellContents

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# setCellContents

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

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

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

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# Named Expressions

# addNamedExpression

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

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

Adds a specified named expression.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionAdded always, unless batch mode is used

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# Named Expressions

# addNamedExpression

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

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

Adds a specified named expression.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionAdded always, unless batch mode is used

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# changeNamedExpression

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

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

Changes a given named expression to a specified formula.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# changeNamedExpression

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

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

Changes a given named expression to a specified formula.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

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

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

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

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

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

example

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

Parameters:

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

Returns: ExportedChange[]

# getAllNamedExpressionsSerialized

▸ getAllNamedExpressionsSerialized(): SerializedNamedExpression[]

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

Returns all named expressions serialized.

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

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

Returns: ExportedChange[]

# getAllNamedExpressionsSerialized

▸ getAllNamedExpressionsSerialized(): SerializedNamedExpression[]

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

Returns all named expressions serialized.

example

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

Returns: SerializedNamedExpression[]

# getNamedExpression

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: SerializedNamedExpression[]

# getNamedExpression

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -793,7 +793,7 @@
 
 // for a named expression that doesn't exist, returns 'undefined':
 const myFormulaTwo = hfInstance.getNamedExpression('uglyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: NamedExpression | undefined

# getNamedExpressionFormula

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: NamedExpression | undefined

# getNamedExpressionFormula

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

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

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

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

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

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -803,7 +803,7 @@
 // returns a normalized formula string corresponding to the passed name from 'Sheet1' (sheetId=0),
 // '=Sheet1!A1+100' for this example
 const myFormula = hfInstance.getNamedExpressionFormula('prettyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: string | undefined

# getNamedExpressionValue

▸ getNamedExpressionValue(expressionName: string, scope?: undefined | number): CellValue | undefined

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

Gets specified named expression value. +

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: string | undefined

# getNamedExpressionValue

▸ getNamedExpressionValue(expressionName: string, scope?: undefined | number): CellValue | undefined

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

Gets specified named expression value. Returns a [[CellValue]] or undefined if the given named expression does not exist.

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

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

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
@@ -813,7 +813,7 @@
 
 // returns the calculated value of a passed named expression, '142' for this example
 const myFormula = hfInstance.getNamedExpressionValue('prettyName', 'Sheet1');
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: CellValue | undefined

# isItPossibleToAddNamedExpression

▸ isItPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number): boolean

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

Returns information whether it is possible to add named expression into a specific scope. +

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: CellValue | undefined

# isItPossibleToAddNamedExpression

▸ isItPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, scope?: undefined | number): boolean

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

Returns information whether it is possible to add named expression into a specific scope. Checks against particular rules to ascertain that addNamedExpression can be called. If returns true, doing addNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

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

example

const hfInstance = HyperFormula.buildFromArray([
@@ -823,7 +823,7 @@
 // should return 'true' for this example,
 // it is possible to add named expression to global scope
 const isAddable = hfInstance.isItPossibleToAddNamedExpression('prettyName', '=Sheet1!$A$1+100');
-

Parameters:

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

Returns: boolean

# isItPossibleToChangeNamedExpression

▸ isItPossibleToChangeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number): boolean

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

Returns information whether it is possible to change named expression in a specific scope. +

Parameters:

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

Returns: boolean

# isItPossibleToChangeNamedExpression

▸ isItPossibleToChangeNamedExpression(expressionName: string, newExpression: RawCellContent, scope?: undefined | number): boolean

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

Returns information whether it is possible to change named expression in a specific scope. Checks against particular rules to ascertain that changeNamedExpression can be called. If returns true, doing changeNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

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

example

const hfInstance = HyperFormula.buildFromArray([
@@ -836,7 +836,7 @@
 // should return 'true' for this example,
 // it is possible to change named expression
 const isAddable = hfInstance.isItPossibleToChangeNamedExpression('prettyName', '=Sheet1!$A$1+100');
-

Parameters:

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

Returns: boolean

# isItPossibleToRemoveNamedExpression

▸ isItPossibleToRemoveNamedExpression(expressionName: string, scope?: undefined | number): boolean

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

Returns information whether it is possible to remove named expression from a specific scope. +

Parameters:

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

Returns: boolean

# isItPossibleToRemoveNamedExpression

▸ isItPossibleToRemoveNamedExpression(expressionName: string, scope?: undefined | number): boolean

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

Returns information whether it is possible to remove named expression from a specific scope. Checks against particular rules to ascertain that removeNamedExpression can be called. If returns true, doing removeNamedExpression operation won't throw any errors. Returns false if the operation might be disrupted.

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

example

const hfInstance = HyperFormula.buildFromArray([
@@ -849,7 +849,7 @@
 // should return 'true' for this example,
 // it is possible to change named expression
 const isAddable = hfInstance.isItPossibleToRemoveNamedExpression('prettyName');
-

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# listNamedExpressions

▸ listNamedExpressions(scope?: undefined | number): string[]

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

Lists named expressions.

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

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

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
expressionName string an expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: boolean

# listNamedExpressions

▸ listNamedExpressions(scope?: undefined | number): string[]

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

Lists named expressions.

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

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

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
  ['50'],
  ['60'],
@@ -865,7 +865,7 @@
 
  // list the expressions, should return: ['alsoPrettyName'] for this example
 const listOfExpressions = hfInstance.listNamedExpressions(0);
-

Parameters:

Name Type Description
scope? undefined | number scope of the named expressions, sheetId for local scope or undefined for global scope

Returns: string[]

# removeNamedExpression

▸ removeNamedExpression(expressionName: string, scope?: undefined | number): ExportedChange[]

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

Removes a named expression.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionRemoved after the expression was removed

fires valuesUpdated if recalculation was triggered by this change

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

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

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
+

Parameters:

Name Type Description
scope? undefined | number scope of the named expressions, sheetId for local scope or undefined for global scope

Returns: string[]

# removeNamedExpression

▸ removeNamedExpression(expressionName: string, scope?: undefined | number): ExportedChange[]

Defined in src/HyperFormula.ts:3896 (opens new window)

Removes a named expression.

Note that this method may trigger dependency graph recalculation.

fires namedExpressionRemoved after the expression was removed

fires valuesUpdated if recalculation was triggered by this change

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NamedExpressionDoesNotExistError]] when the given expression does not exist.

throws [[NoSheetWithIdError]] if no sheet with given sheetId exists

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
 ]);
 
@@ -874,7 +874,7 @@
 
 // remove the named expression
 const changes = hfInstance.removeNamedExpression('prettyName', 0);
-

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: ExportedChange[]

# Helpers

# calculateFormula

▸ calculateFormula(formulaString: string, sheetId: number): CellValue | CellValue[][]

Defined in src/HyperFormula.ts:4044 (opens new window)

Calculates fire-and-forget formula, returns the calculated value.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e. doesn't start with =).

throws [[NoSheetWithIdError]] when the provided sheetID doesn't exist.

example

const hfInstance = HyperFormula.buildFromSheets({
+

Parameters:

Name Type Description
expressionName string expression name, case-insensitive.
scope? undefined | number scope definition, sheetId for local scope or undefined for global scope

Returns: ExportedChange[]

# Helpers

# calculateFormula

▸ calculateFormula(formulaString: string, sheetId: number): CellValue | CellValue[][]

Defined in src/HyperFormula.ts:4044 (opens new window)

Calculates fire-and-forget formula, returns the calculated value.

throws [[ExpectedValueOfTypeError]] if any of its basic type arguments is of wrong type.

throws [[NotAFormulaError]] when the provided string is not a valid formula (i.e. doesn't start with =).

throws [[NoSheetWithIdError]] when the provided sheetID doesn't exist.

example

const hfInstance = HyperFormula.buildFromSheets({
  Sheet1: [['58']],
  Sheet2: [['1', '2', '3'], ['4', '5', '6']]
 });
@@ -885,15 +885,15 @@
 
 // for this example, returns [['11', '12', '13'], ['14', '15', '16']]
 const calculatedFormula = hfInstance.calculateFormula('=A1:B3+10', 1);
-

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.
sheetId number The ID of a sheet in context of which the formula gets evaluated.

Returns: CellValue | CellValue[][]

# getCellDependents

▸ getCellDependents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2895 (opens new window)

Returns all the out-neighbors in the dependency graph for a given cell address or range. Including:

The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "Optimizations for large ranges".

throws [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
+

Parameters:

Name Type Description
formulaString string A formula in a proper format, starting with =.
sheetId number The ID of a sheet in context of which the formula gets evaluated.

Returns: CellValue | CellValue[][]

# getCellDependents

▸ getCellDependents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2895 (opens new window)

Returns all the out-neighbors in the dependency graph for a given cell address or range. Including:

The exact result depends on the optimizations applied by the HyperFormula to the dependency graph, some of which are described in the section "Optimizations for large ranges".

throws [[ExpectedValueOfTypeError]] if address is not [[SimpleCellAddress]] or [[SimpleCellRange]]

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
 
 hfInstance.getCellDependents({ sheet: 0, col: 0, row: 0});
 // returns [{ sheet: 0, col: 1, row: 0}, { sheet: 0, col: 2, row: 0}]
-

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getCellPrecedents

▸ getCellPrecedents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2931 (opens new window)

Returns all the in-neighbors in the dependency graph for a given cell address or range. In particular:

throws [[ExpectedValueOfTypeError]] if address is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
+

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# getCellPrecedents

▸ getCellPrecedents(address: SimpleCellAddress | SimpleCellRange): (SimpleCellRange | SimpleCellAddress)[]

Defined in src/HyperFormula.ts:2931 (opens new window)

Returns all the in-neighbors in the dependency graph for a given cell address or range. In particular:

throws [[ExpectedValueOfTypeError]] if address is of wrong type

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray( [ ['1', '=A1', '=A1+B1'] ] );
 
 hfInstance.getCellPrecedents({ sheet: 0, col: 2, row: 0});
 // returns [{ sheet: 0, col: 0, row: 0}, { sheet: 0, col: 1, row: 0}]
-

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# normalizeFormula

▸ normalizeFormula(formulaString: string): string

Defined in src/HyperFormula.ts:4008 (opens new window)

Parses and then unparses a formula. +

Parameters:

Name Type Description
address SimpleCellAddress | SimpleCellRange object representation of an absolute address or range of addresses

Returns: (SimpleCellRange | SimpleCellAddress)[]

# normalizeFormula

▸ normalizeFormula(formulaString: string): string

Defined in src/HyperFormula.ts:4008 (opens new window)

Parses and then unparses a formula. Returns a normalized formula (e.g. restores the original capitalization of sheet names, function names, cell addresses, and named expressions).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[NotAFormulaError]] when the provided string is not a valid formula, i.e. does not start with "="

example

const hfInstance = HyperFormula.buildFromArray([
  ['42'],
  ['50'],
@@ -904,25 +904,25 @@
 
 // returns '=3*$A$1'
 const normalizedFormula = hfInstance.normalizeFormula('=3*$a$1');
-

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: string

# numberToDate

▸ numberToDate(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4196 (opens new window)

Interprets number as a date.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: string

# numberToDate

▸ numberToDate(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4196 (opens new window)

Interprets number as a date.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass the number of days since nullDate
 // the method should return formatted date, for this example:
 // {year: 2020, month: 1, day: 15}
 const dateFromNumber = hfInstance.numberToDate(43845);
-

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are ignored.

Returns: DateTime

# numberToDateTime

▸ numberToDateTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4172 (opens new window)

Interprets number as a date + time.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are ignored.

Returns: DateTime

# numberToDateTime

▸ numberToDateTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4172 (opens new window)

Interprets number as a date + time.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass the number of days since nullDate
 // the method should return formatted date and time, for this example:
 // {year: 2020, month: 1, day: 15, hours: 2, minutes: 24, seconds: 0}
 const dateTimeFromNumber = hfInstance.numberToDateTime(43845.1);
 
-

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.

Returns: DateTime

# numberToTime

▸ numberToTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4219 (opens new window)

Interprets number as a time (hours/minutes/seconds).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
inputNumber number number of days since nullDate, should be non-negative, fractions are interpreted as hours/minutes/seconds.

Returns: DateTime

# numberToTime

▸ numberToTime(inputNumber: number): DateTime

Defined in src/HyperFormula.ts:4219 (opens new window)

Interprets number as a time (hours/minutes/seconds).

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 
 // pass a number to be interpreted as a time
 // should return {hours: 26, minutes: 24} for this example
 const timeFromNumber = hfInstance.numberToTime(1.1);
-

Parameters:

Name Type Description
inputNumber number time in 24h units.

Returns: DateTime

# simpleCellAddressFromString

▸ simpleCellAddressFromString(cellAddress: string, sheetId: number): SimpleCellAddress | undefined

Defined in src/HyperFormula.ts:2781 (opens new window)

Computes simple (absolute) address of a cell address based on its string representation. +

Parameters:

Name Type Description
inputNumber number time in 24h units.

Returns: DateTime

# simpleCellAddressFromString

▸ simpleCellAddressFromString(cellAddress: string, sheetId: number): SimpleCellAddress | undefined

Defined in src/HyperFormula.ts:2781 (opens new window)

Computes simple (absolute) address of a cell address based on its string representation. If sheet name is present in string representation but not present in the engine, returns undefined.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
@@ -937,18 +937,18 @@
 
 // returns 'undefined', as there's no 'Sheet 2' in the HyperFormula instance
 const simpleCellAddressTwo = hfInstance.simpleCellAddressFromString('Sheet2!A6');
-

Parameters:

Name Type Description
cellAddress string string representation of cell address in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellAddress | undefined

# simpleCellAddressToString

▸ simpleCellAddressToString(cellAddress: SimpleCellAddress, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2833 (opens new window)

Returns string representation of an absolute address in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
cellAddress string string representation of cell address in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellAddress | undefined

# simpleCellAddressToString

▸ simpleCellAddressToString(cellAddress: SimpleCellAddress, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2833 (opens new window)

Returns string representation of an absolute address in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
 // should return 'B2'
 const A1Notation = hfInstance.simpleCellAddressToString({ sheet: 0, col: 1, row: 1 }, 0);
-

Parameters:

Name Type Description
cellAddress SimpleCellAddress object representation of an absolute address
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# simpleCellRangeFromString

▸ simpleCellRangeFromString(cellRange: string, sheetId: number): SimpleCellRange | undefined

Defined in src/HyperFormula.ts:2808 (opens new window)

Computes simple (absolute) address of a cell range based on its string representation. +

Parameters:

Name Type Description
cellAddress SimpleCellAddress object representation of an absolute address
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# simpleCellRangeFromString

▸ simpleCellRangeFromString(cellRange: string, sheetId: number): SimpleCellRange | undefined

Defined in src/HyperFormula.ts:2808 (opens new window)

Computes simple (absolute) address of a cell range based on its string representation. If sheet name is present in string representation but not present in the engine, returns undefined.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 
 // should return { start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 0 } }
 const simpleCellAddress = hfInstance.simpleCellRangeFromString('A1:A2', 0);
-

Parameters:

Name Type Description
cellRange string string representation of cell range in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellRange | undefined

# simpleCellRangeToString

▸ simpleCellRangeToString(cellRange: SimpleCellRange, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2864 (opens new window)

Returns string representation of an absolute range in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

Name Type Description
cellRange string string representation of cell range in A1 notation
sheetId number context used in case of missing sheet in the first argument

Returns: SimpleCellRange | undefined

# simpleCellRangeToString

▸ simpleCellRangeToString(cellRange: SimpleCellRange, sheetId: number): string | undefined

Defined in src/HyperFormula.ts:2864 (opens new window)

Returns string representation of an absolute range in A1 notation or undefined if the sheet index is not present in the engine.

throws [[ExpectedValueOfTypeError]] if its arguments are of wrong type

example

const hfInstance = HyperFormula.buildEmpty();
 hfInstance.addSheet('Sheet0'); //sheetId = 0
 hfInstance.addSheet('Sheet1'); //sheetId = 1
 
@@ -957,13 +957,13 @@
 
  // should return 'Sheet1!B2:C2'
 const another = hfInstance.simpleCellRangeToString({ start: { sheet: 1, col: 1, row: 1 }, end: { sheet: 1, col: 2, row: 1 } }, 0);
-

Parameters:

Name Type Description
cellRange SimpleCellRange object representation of an absolute range
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# validateFormula

▸ validateFormula(formulaString: string): boolean

Defined in src/HyperFormula.ts:4073 (opens new window)

Validates the formula. +

Parameters:

Name Type Description
cellRange SimpleCellRange object representation of an absolute range
sheetId number context used in case of missing sheet in the first argument

Returns: string | undefined

# validateFormula

▸ validateFormula(formulaString: string): boolean

Defined in src/HyperFormula.ts:4073 (opens new window)

Validates the formula. If the provided string starts with "=" and is a parsable formula, the method returns true. The validation is purely grammatical: the method doesn't verify if the formula can be calculated or not.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// checks if the given string is a valid formula, should return 'true' for this example
 const isFormula = hfInstance.validateFormula('=SUM(1, 2)');
-

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: boolean

# Clipboard

# clearClipboard

▸ clearClipboard(): void

Defined in src/HyperFormula.ts:2270 (opens new window)

Clears the clipboard content.

example

// clears the clipboard, isClipboardEmpty() should return true if called afterwards
+

Parameters:

Name Type Description
formulaString string a formula in a proper format - it must start with "="

Returns: boolean

# Clipboard

# clearClipboard

▸ clearClipboard(): void

Defined in src/HyperFormula.ts:2270 (opens new window)

Clears the clipboard content.

example

// clears the clipboard, isClipboardEmpty() should return true if called afterwards
 hfInstance.clearClipboard();
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: void

# copy

▸ copy(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2136 (opens new window)

Stores a copy of the cell block in internal clipboard for the further paste. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: void

# copy

▸ copy(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2136 (opens new window)

Stores a copy of the cell block in internal clipboard for the further paste. Returns the copied values for use in external clipboard.

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2'],
 ]);
@@ -973,7 +973,7 @@
   start: { sheet: 0, col: 1, row: 0 },
   end: { sheet: 0, col: 1, row: 0 },
 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to copy

Returns: CellValue[][]

# cut

▸ cut(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2174 (opens new window)

Stores information of the cell block in internal clipboard for further paste. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to copy

Returns: CellValue[][]

# cut

▸ cut(source: SimpleCellRange): CellValue[][]

Defined in src/HyperFormula.ts:2174 (opens new window)

Stores information of the cell block in internal clipboard for further paste. Calling paste right after this method is equivalent to call moveCells. Almost any CRUD operation called after this method will abort the cut operation. Returns the cut values for use in external clipboard.

throws [[ExpectedValueOfTypeError]] if source is of wrong type

throws [[SheetsNotEqual]] if range provided has distinct sheet numbers for start and end

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

example

const hfInstance = HyperFormula.buildFromArray([
@@ -985,7 +985,7 @@
   start: { sheet: 0, col: 0, row: 0 },
   end: { sheet: 0, col: 0, row: 0 },
 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to cut

Returns: CellValue[][]

# isClipboardEmpty

▸ isClipboardEmpty(): boolean

Defined in src/HyperFormula.ts:2253 (opens new window)

Returns information whether there is something in the clipboard.

example

const hfInstance = HyperFormula.buildFromArray([
+

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
source SimpleCellRange rectangle range to cut

Returns: CellValue[][]

# isClipboardEmpty

▸ isClipboardEmpty(): boolean

Defined in src/HyperFormula.ts:2253 (opens new window)

Returns information whether there is something in the clipboard.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
 ]);
 
@@ -997,7 +997,7 @@
 
 // returns 'false', there is content in the clipboard
 const isClipboardEmpty = hfInstance.isClipboardEmpty();
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: boolean

# paste

▸ paste(targetLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:2221 (opens new window)

When called after copy it pastes copied values and formulas into a cell block. +

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Returns: boolean

# paste

▸ paste(targetLeftCorner: SimpleCellAddress): ExportedChange[]

Defined in src/HyperFormula.ts:2221 (opens new window)

When called after copy it pastes copied values and formulas into a cell block. When called after cut it performs moveCells operation into the cell block. Does nothing if the clipboard is empty.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoSheetWithIdError]] when the given sheet ID does not exist

throws [[EvaluationSuspendedError]] when the evaluation is suspended

throws [[SheetSizeLimitExceededError]] when performing this operation would result in sheet size limits exceeding

throws [[NothingToPasteError]] when clipboard is empty

throws [[TargetLocationHasArrayError]] when the selected target area has array inside

throws [[ExpectedValueOfTypeError]] if targetLeftCorner is of wrong type

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2'],
@@ -1011,7 +1011,7 @@
 
 // returns a list of modified cells: their absolute addresses and new values
 const changes = hfInstance.paste({ sheet: 0, col: 1, row: 0 });
-

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
targetLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# Undo and Redo

# clearRedoStack

▸ clearRedoStack(): void

Defined in src/HyperFormula.ts:2298 (opens new window)

Clears the redo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
+

The usage of the internal clipboard is described thoroughly in the Clipboard Operations guide.

Parameters:

Name Type Description
targetLeftCorner SimpleCellAddress upper left address of the target cell block

Returns: ExportedChange[]

# Undo and Redo

# clearRedoStack

▸ clearRedoStack(): void

Defined in src/HyperFormula.ts:2298 (opens new window)

Clears the redo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '3'],
 ]);
 
@@ -1026,7 +1026,7 @@
 
 // clear the redo stack
 hfInstance.clearRedoStack();
-

Returns: void

# clearUndoStack

▸ clearUndoStack(): void

Defined in src/HyperFormula.ts:2323 (opens new window)

Clears the undo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: void

# clearUndoStack

▸ clearUndoStack(): void

Defined in src/HyperFormula.ts:2323 (opens new window)

Clears the undo stack in undoRedo history.

example

const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '3'],
 ]);
 
@@ -1038,11 +1038,11 @@
 
 // clear the undo stack
 hfInstance.clearUndoStack();
-

Returns: void

# isThereSomethingToRedo

▸ isThereSomethingToRedo(): boolean

Defined in src/HyperFormula.ts:1148 (opens new window)

Checks if there is at least one operation that can be re-done.

example

hfInstance.undo();
+

Returns: void

# isThereSomethingToRedo

▸ isThereSomethingToRedo(): boolean

Defined in src/HyperFormula.ts:1148 (opens new window)

Checks if there is at least one operation that can be re-done.

example

hfInstance.undo();
 
 // when there is an action to redo, this returns 'true'
 const isSomethingToRedo = hfInstance.isThereSomethingToRedo();
-

Returns: boolean

# isThereSomethingToUndo

▸ isThereSomethingToUndo(): boolean

Defined in src/HyperFormula.ts:1131 (opens new window)

Checks if there is at least one operation that can be undone.

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: boolean

# isThereSomethingToUndo

▸ isThereSomethingToUndo(): boolean

Defined in src/HyperFormula.ts:1131 (opens new window)

Checks if there is at least one operation that can be undone.

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
  ['3'],
@@ -1054,7 +1054,7 @@
 // should return 'true', it is possible to undo last operation
 // which is removing rows in this example
 const isSomethingToUndo = hfInstance.isThereSomethingToUndo();
-

Returns: boolean

# redo

▸ redo(): ExportedChange[]

Defined in src/HyperFormula.ts:1105 (opens new window)

Re-do recently undone operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToRedoError]] when there is no operation running that can be re-done

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: boolean

# redo

▸ redo(): ExportedChange[]

Defined in src/HyperFormula.ts:1105 (opens new window)

Re-do recently undone operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToRedoError]] when there is no operation running that can be re-done

example

const hfInstance = HyperFormula.buildFromArray([
  ['1'],
  ['2'],
  ['3'],
@@ -1068,7 +1068,7 @@
 
 // do a redo, it should return the values after removing the second row: [['1'], ['3']]
 const changes = hfInstance.redo();
-

Returns: ExportedChange[]

# undo

▸ undo(): ExportedChange[]

Defined in src/HyperFormula.ts:1071 (opens new window)

Undo the previous operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToUndoError]] when there is no operation running that can be undone

example

const hfInstance = HyperFormula.buildFromArray([
+

Returns: ExportedChange[]

# undo

▸ undo(): ExportedChange[]

Defined in src/HyperFormula.ts:1071 (opens new window)

Undo the previous operation.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

throws [[NoOperationToUndoError]] when there is no operation running that can be undone

example

const hfInstance = HyperFormula.buildFromArray([
  ['1', '2'],
  ['3', ''],
 ]);
@@ -1078,7 +1078,7 @@
 
 // undo the operation, it should return the changes
 const changes = hfInstance.undo();
-

Returns: ExportedChange[]

# Batch

# batch

▸ batch(batchOperations: function): ExportedChange[]

Defined in src/HyperFormula.ts:3415 (opens new window)

Runs multiple operations and recomputes formulas at the end.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationSuspended always

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
+

Returns: ExportedChange[]

# Batch

# batch

▸ batch(batchOperations: function): ExportedChange[]

Defined in src/HyperFormula.ts:3415 (opens new window)

Runs multiple operations and recomputes formulas at the end.

Note that this method may trigger dependency graph recalculation.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationSuspended always

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
 });
@@ -1090,7 +1090,7 @@
  hfInstance.setCellContents({ col: 3, row: 0, sheet: 0 }, [['=B1']]);
  hfInstance.setCellContents({ col: 4, row: 0, sheet: 0 }, [['=A1']]);
 });
-

Parameters:

▪ batchOperations: function

a function with operations to be performed

▸ (): void

Returns: ExportedChange[]

# isEvaluationSuspended

▸ isEvaluationSuspended(): boolean

Defined in src/HyperFormula.ts:3524 (opens new window)

Checks if the dependency graph recalculation process is suspended or not.

example

const hfInstance = HyperFormula.buildEmpty();
+

Parameters:

▪ batchOperations: function

a function with operations to be performed

▸ (): void

Returns: ExportedChange[]

# isEvaluationSuspended

▸ isEvaluationSuspended(): boolean

Defined in src/HyperFormula.ts:3524 (opens new window)

Checks if the dependency graph recalculation process is suspended or not.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // suspend the evaluation
 hfInstance.suspendEvaluation();
@@ -1100,7 +1100,7 @@
 const isEvaluationSuspended = hfInstance.isEvaluationSuspended();
 
 const changes = hfInstance.resumeEvaluation();
-

Returns: boolean

# resumeEvaluation

▸ resumeEvaluation(): ExportedChange[]

Defined in src/HyperFormula.ts:3498 (opens new window)

Resumes the dependency graph recalculation that was suspended with suspendEvaluation. +

Returns: boolean

# resumeEvaluation

▸ resumeEvaluation(): ExportedChange[]

Defined in src/HyperFormula.ts:3498 (opens new window)

Resumes the dependency graph recalculation that was suspended with suspendEvaluation. It also triggers the recalculation and returns changes that are a result of all batched operations.

fires valuesUpdated if recalculation was triggered by this change

fires evaluationResumed after the recomputation of necessary values

example

const hfInstance = HyperFormula.buildFromSheets({
  MySheet1: [ ['1'] ],
  MySheet2: [ ['10'] ],
@@ -1119,7 +1119,7 @@
 
 // resume the evaluation
 const changes = hfInstance.resumeEvaluation();
-

Returns: ExportedChange[]

# suspendEvaluation

▸ suspendEvaluation(): void

Defined in src/HyperFormula.ts:3462 (opens new window)

Suspends the dependency graph recalculation. +

Returns: ExportedChange[]

# suspendEvaluation

▸ suspendEvaluation(): void

Defined in src/HyperFormula.ts:3462 (opens new window)

Suspends the dependency graph recalculation. It allows optimizing the performance. With this method, multiple CRUD operations can be done without triggering recalculation after every operation. Suspending evaluation should result in an overall faster calculation compared to recalculating after each operation separately. @@ -1141,7 +1141,7 @@ // use resumeEvaluation to resume const changes = hfInstance.resumeEvaluation(); -

Returns: void

# Events

# off

▸ off‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4305 (opens new window)

Unsubscribes from an event or from all events. +

Returns: void

# Events

# off

▸ off‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4305 (opens new window)

Unsubscribes from an event or from all events. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // define a simple function to be called upon emitting an event
@@ -1159,7 +1159,7 @@
 
 // add a sheet, the console should not print anything
 hfInstance.addSheet('FooBaz');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# on

▸ on‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4245 (opens new window)

Subscribes to an event. +

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# on

▸ on‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4245 (opens new window)

Subscribes to an event. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // subscribe to a 'sheetAdded', pass a simple handler
@@ -1168,7 +1168,7 @@
 // add a sheet to trigger an event,
 // console should print 'foo' after each time sheet is added in this example
 hfInstance.addSheet('FooBar');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# once

▸ once‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4271 (opens new window)

Subscribes to an event once. +

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# once

▸ once‹Event›(event: Event, listener: Listeners[Event]): void

Defined in src/HyperFormula.ts:4271 (opens new window)

Subscribes to an event once. For the list of all available events, see Listeners.

example

const hfInstance = HyperFormula.buildEmpty();
 
 // subscribe to a 'sheetAdded', pass a simple handler
@@ -1178,11 +1178,11 @@
 // console should print 'foo' only once when the sheet is added in this example
 hfInstance.addSheet('FooBar');
 hfInstance.addSheet('FooBaz');
-

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# Custom Functions

# getAllFunctionPlugins

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:4148 (opens new window)

Returns classes of all plugins registered in this instance of HyperFormula

example

const hfInstance = HyperFormula.buildEmpty();
+

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type Description
event Event the name of the event to subscribe to
listener Listeners[Event] to be called when event is emitted

Returns: void

# Custom Functions

# getAllFunctionPlugins

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:4148 (opens new window)

Returns classes of all plugins registered in this instance of HyperFormula

example

const hfInstance = HyperFormula.buildEmpty();
 
 // return classes of all plugins registered, assign to a variable
 const allNames = hfInstance.getAllFunctionPlugins();
-

Returns: FunctionPluginDefinition[]

# getFunctionPlugin

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:4130 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Returns: FunctionPluginDefinition[]

# getFunctionPlugin

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:4130 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 const hfInstance = HyperFormula.buildEmpty();
@@ -1192,14 +1192,14 @@
 
 // get the plugin
 const myPlugin = hfInstance.getFunctionPlugin('EXAMPLE');
-

Parameters:

Name Type Description
functionId string id of a function, e.g. 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getRegisteredFunctionNames

▸ getRegisteredFunctionNames(): string[]

Defined in src/HyperFormula.ts:4102 (opens new window)

Returns translated names of all functions registered in this instance of HyperFormula +

Parameters:

Name Type Description
functionId string id of a function, e.g. 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getRegisteredFunctionNames

▸ getRegisteredFunctionNames(): string[]

Defined in src/HyperFormula.ts:4102 (opens new window)

Returns translated names of all functions registered in this instance of HyperFormula according to the language set in the configuration

example

const hfInstance = HyperFormula.buildEmpty();
 
 // return translated names of all functions, assign to a variable
 const allNames = hfInstance.getRegisteredFunctionNames();
-

Returns: string[]

# Static Methods

# getAllFunctionPlugins Static

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:610 (opens new window)

Returns classes of all plugins registered in HyperFormula.

example

// return classes of all plugins
+

Returns: string[]

# Static Methods

# getAllFunctionPlugins Static

▸ getAllFunctionPlugins(): FunctionPluginDefinition[]

Defined in src/HyperFormula.ts:610 (opens new window)

Returns classes of all plugins registered in HyperFormula.

example

// return classes of all plugins
 const allClasses = HyperFormula.getAllFunctionPlugins();
-

Returns: FunctionPluginDefinition[]

# getFunctionPlugin Static

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:594 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Returns: FunctionPluginDefinition[]

# getFunctionPlugin Static

▸ getFunctionPlugin(functionId: string): FunctionPluginDefinition | undefined

Defined in src/HyperFormula.ts:594 (opens new window)

Returns class of a plugin used by function with given id

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a plugin
@@ -1207,29 +1207,29 @@
 
 // return the class of a given plugin
 const myFunctionClass = HyperFormula.getFunctionPlugin('EXAMPLE');
-

Parameters:

Name Type Description
functionId string id of a function, e.g. 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getLanguage Static

▸ getLanguage(languageCode: string): TranslationPackage

Defined in src/HyperFormula.ts:345 (opens new window)

Returns registered language from its code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when trying to retrieve not registered language

example

// return registered language
+

Parameters:

Name Type Description
functionId string id of a function, e.g. 'SUMIF'

Returns: FunctionPluginDefinition | undefined

# getLanguage Static

▸ getLanguage(languageCode: string): TranslationPackage

Defined in src/HyperFormula.ts:345 (opens new window)

Returns registered language from its code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when trying to retrieve not registered language

example

// return registered language
 const language = HyperFormula.getLanguage('enGB');
-

Parameters:

Name Type Description
languageCode string code string of the translation package

Returns: TranslationPackage

# getRegisteredFunctionNames Static

▸ getRegisteredFunctionNames(code: string): string[]

Defined in src/HyperFormula.ts:566 (opens new window)

Returns translated names of all registered functions for a given language

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// return a list of function names registered for enGB
+

Parameters:

Name Type Description
languageCode string code string of the translation package

Returns: TranslationPackage

# getRegisteredFunctionNames Static

▸ getRegisteredFunctionNames(code: string): string[]

Defined in src/HyperFormula.ts:566 (opens new window)

Returns translated names of all registered functions for a given language

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// return a list of function names registered for enGB
 const allNames = HyperFormula.getRegisteredFunctionNames('enGB');
-

Parameters:

Name Type Description
code string language code

Returns: string[]

# getRegisteredLanguagesCodes Static

▸ getRegisteredLanguagesCodes(): string[]

Defined in src/HyperFormula.ts:424 (opens new window)

Returns all registered languages codes.

example

// should return all registered language codes: ['enGB', 'plPL']
+

Parameters:

Name Type Description
code string language code

Returns: string[]

# getRegisteredLanguagesCodes Static

▸ getRegisteredLanguagesCodes(): string[]

Defined in src/HyperFormula.ts:424 (opens new window)

Returns all registered languages codes.

example

// should return all registered language codes: ['enGB', 'plPL']
 const registeredLanguages = HyperFormula.getRegisteredLanguagesCodes();
-

Returns: string[]

# registerFunction Static

▸ registerFunction(functionId: string, plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:502 (opens new window)

Registers a function with a given id if such exists in a plugin.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
+

Returns: string[]

# registerFunction Static

▸ registerFunction(functionId: string, plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:502 (opens new window)

Registers a function with a given id if such exists in a plugin.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[FunctionPluginValidationError]] when function with a given id does not exist in plugin or plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a function
 HyperFormula.registerFunction('EXAMPLE', MyExamplePlugin);
-

Parameters:

Name Type Description
functionId string function id, e.g. 'SUMIF'
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage translations for the function name

Returns: void

# registerFunctionPlugin Static

▸ registerFunctionPlugin(plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:452 (opens new window)

Registers all functions in a given plugin with optional translations.

Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used. +

Parameters:

Name Type Description
functionId string function id, e.g. 'SUMIF'
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage translations for the function name

Returns: void

# registerFunctionPlugin Static

▸ registerFunctionPlugin(plugin: FunctionPluginDefinition, translations?: FunctionTranslationsPackage): void

Defined in src/HyperFormula.ts:452 (opens new window)

Registers all functions in a given plugin with optional translations.

Note: FunctionPlugins must be registered prior to the creation of HyperFormula instances in which they are used. HyperFormula instances created prior to the registration of a FunctionPlugin are unable to access the FunctionPlugin. Registering a FunctionPlugin with [[custom-functions]] requires the translations parameter.

throws [[FunctionPluginValidationError]] when plugin class definition is not consistent with metadata

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register the plugin
 HyperFormula.registerFunctionPlugin(MyExamplePlugin);
-

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage optional package of function names translations

Returns: void

# registerLanguage Static

▸ registerLanguage(languageCode: string, languagePackage: RawTranslationPackage): void

Defined in src/HyperFormula.ts:376 (opens new window)

Registers language under given code string.

For more information, see the Localizing functions guide.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

throws [[LanguageAlreadyRegisteredError]] when given language is already registered

example

// return registered language
+

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class
translations? FunctionTranslationsPackage optional package of function names translations

Returns: void

# registerLanguage Static

▸ registerLanguage(languageCode: string, languagePackage: RawTranslationPackage): void

Defined in src/HyperFormula.ts:376 (opens new window)

Registers language under given code string.

For more information, see the Localizing functions guide.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[ProtectedFunctionTranslationError]] when trying to register translation for protected function

throws [[LanguageAlreadyRegisteredError]] when given language is already registered

example

// return registered language
 HyperFormula.registerLanguage('enUS', enUS);
 const engine = HyperFormula.buildEmpty({language: 'enUS'});
-

Parameters:

Name Type Description
languageCode string code string of the translation package
languagePackage RawTranslationPackage translation package to be registered

Returns: void

# unregisterAllFunctions Static

▸ unregisterAllFunctions(): void

Defined in src/HyperFormula.ts:547 (opens new window)

Clears function registry.

Note: This method does not affect the existing HyperFormula instances.

example

HyperFormula.unregisterAllFunctions();
-

Returns: void

# unregisterFunction Static

▸ unregisterFunction(functionId: string): void

Defined in src/HyperFormula.ts:530 (opens new window)

Unregisters a function with a given id.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
+

Parameters:

Name Type Description
languageCode string code string of the translation package
languagePackage RawTranslationPackage translation package to be registered

Returns: void

# unregisterAllFunctions Static

▸ unregisterAllFunctions(): void

Defined in src/HyperFormula.ts:547 (opens new window)

Clears function registry.

Note: This method does not affect the existing HyperFormula instances.

example

HyperFormula.unregisterAllFunctions();
+

Returns: void

# unregisterFunction Static

▸ unregisterFunction(functionId: string): void

Defined in src/HyperFormula.ts:530 (opens new window)

Unregisters a function with a given id.

Note: This method does not affect the existing HyperFormula instances.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

example

// import your own plugin
 import { MyExamplePlugin } from './file_with_your_plugin';
 
 // register a function
@@ -1237,12 +1237,12 @@
 
 // unregister a function
 HyperFormula.unregisterFunction('EXAMPLE');
-

Parameters:

Name Type Description
functionId string function id, e.g. 'SUMIF'

Returns: void

# unregisterFunctionPlugin Static

▸ unregisterFunctionPlugin(plugin: FunctionPluginDefinition): void

Defined in src/HyperFormula.ts:474 (opens new window)

Unregisters all functions defined in given plugin.

Note: This method does not affect the existing HyperFormula instances.

example

// get the class of a plugin
+

Parameters:

Name Type Description
functionId string function id, e.g. 'SUMIF'

Returns: void

# unregisterFunctionPlugin Static

▸ unregisterFunctionPlugin(plugin: FunctionPluginDefinition): void

Defined in src/HyperFormula.ts:474 (opens new window)

Unregisters all functions defined in given plugin.

Note: This method does not affect the existing HyperFormula instances.

example

// get the class of a plugin
 const registeredPluginClass = HyperFormula.getFunctionPlugin('EXAMPLE');
 
 // unregister all functions defined in a plugin of ID 'EXAMPLE'
 HyperFormula.unregisterFunctionPlugin(registeredPluginClass);
-

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class

Returns: void

# unregisterLanguage Static

▸ unregisterLanguage(languageCode: string): void

Defined in src/HyperFormula.ts:404 (opens new window)

Unregisters language that is registered under given code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when given language is not registered

example

// register the language for the instance
+

Parameters:

Name Type Description
plugin FunctionPluginDefinition plugin class

Returns: void

# unregisterLanguage Static

▸ unregisterLanguage(languageCode: string): void

Defined in src/HyperFormula.ts:404 (opens new window)

Unregisters language that is registered under given code string.

throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type

throws [[LanguageNotRegisteredError]] when given language is not registered

example

// register the language for the instance
 HyperFormula.registerLanguage('plPL', plPL);
 
 // unregister plPL
@@ -1256,6 +1256,6 @@
       
       →
- + \ No newline at end of file diff --git a/api/enums/events.html b/api/enums/events.html index e64b9393e..8b07c0a3a 100644 --- a/api/enums/events.html +++ b/api/enums/events.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# Events Enumeration

# Enumeration members

# EvaluationResumed

• EvaluationResumed: = "evaluationResumed"

Defined in src/Emitter.ts:17 (opens new window)

# EvaluationSuspended

• EvaluationSuspended: = "evaluationSuspended"

Defined in src/Emitter.ts:16 (opens new window)

# NamedExpressionAdded

• NamedExpressionAdded: = "namedExpressionAdded"

Defined in src/Emitter.ts:13 (opens new window)

# NamedExpressionRemoved

• NamedExpressionRemoved: = "namedExpressionRemoved"

Defined in src/Emitter.ts:14 (opens new window)

# SheetAdded

• SheetAdded: = "sheetAdded"

Defined in src/Emitter.ts:10 (opens new window)

# SheetRemoved

• SheetRemoved: = "sheetRemoved"

Defined in src/Emitter.ts:11 (opens new window)

# SheetRenamed

• SheetRenamed: = "sheetRenamed"

Defined in src/Emitter.ts:12 (opens new window)

# ValuesUpdated

• ValuesUpdated: = "valuesUpdated"

Defined in src/Emitter.ts:15 (opens new window)

- + (opens new window)

# Events Enumeration

# Enumeration members

# EvaluationResumed

• EvaluationResumed: = "evaluationResumed"

Defined in src/Emitter.ts:17 (opens new window)

# EvaluationSuspended

• EvaluationSuspended: = "evaluationSuspended"

Defined in src/Emitter.ts:16 (opens new window)

# NamedExpressionAdded

• NamedExpressionAdded: = "namedExpressionAdded"

Defined in src/Emitter.ts:13 (opens new window)

# NamedExpressionRemoved

• NamedExpressionRemoved: = "namedExpressionRemoved"

Defined in src/Emitter.ts:14 (opens new window)

# SheetAdded

• SheetAdded: = "sheetAdded"

Defined in src/Emitter.ts:10 (opens new window)

# SheetRemoved

• SheetRemoved: = "sheetRemoved"

Defined in src/Emitter.ts:11 (opens new window)

# SheetRenamed

• SheetRenamed: = "sheetRenamed"

Defined in src/Emitter.ts:12 (opens new window)

# ValuesUpdated

• ValuesUpdated: = "valuesUpdated"

Defined in src/Emitter.ts:15 (opens new window)

+ \ No newline at end of file diff --git a/api/globals.html b/api/globals.html index dc0b6b2e3..268f815e0 100644 --- a/api/globals.html +++ b/api/globals.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# HyperFormula API reference

# Type aliases

# ConfigParamsList

Ƭ ConfigParamsList: keyof ConfigParams

Defined in src/Config.ts:487 (opens new window)

# Variables

# privatePool Const

• privatePool: WeakMap‹Config, object› = new WeakMap()

Defined in src/Config.ts:26 (opens new window)

# Functions

# getDefaultConfig

▸ getDefaultConfig(): ConfigParams

Defined in src/Config.ts:797 (opens new window)

Returns: ConfigParams

# getFullConfigFromPartial

▸ getFullConfigFromPartial(partialConfig: Partial‹ConfigParams›): ConfigParams

Defined in src/Config.ts:783 (opens new window)

Parameters:

Name Type
partialConfig Partial‹ConfigParams›

Returns: ConfigParams

- + (opens new window)

# HyperFormula API reference

# Type aliases

# ConfigParamsList

Ƭ ConfigParamsList: keyof ConfigParams

Defined in src/Config.ts:487 (opens new window)

# Variables

# privatePool Const

• privatePool: WeakMap‹Config, object› = new WeakMap()

Defined in src/Config.ts:26 (opens new window)

# Functions

# getDefaultConfig

▸ getDefaultConfig(): ConfigParams

Defined in src/Config.ts:797 (opens new window)

Returns: ConfigParams

# getFullConfigFromPartial

▸ getFullConfigFromPartial(partialConfig: Partial‹ConfigParams›): ConfigParams

Defined in src/Config.ts:783 (opens new window)

Parameters:

Name Type
partialConfig Partial‹ConfigParams›

Returns: ConfigParams

+ \ No newline at end of file diff --git a/api/index.html b/api/index.html index 783229893..95f0e9c90 100644 --- a/api/index.html +++ b/api/index.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# HyperFormula API reference

Welcome to the HyperFormula v2.6.0 API!

The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.

Current build: 19/09/2023 11:06:12

# API reference index

The following sections explain shortly what can be found in the left sidebar navigation menu.

# HyperFormula

This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.

The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:

const sheetData = [
+     (opens new window)    
 
# HyperFormula API reference
 
Welcome to the HyperFormula v2.6.0 API!
 
The API reference documentation provides detailed information for methods, error types, event types, and all the configuration options available in HyperFormula.
 
Current build: 26/09/2023 14:21:35
 
# API reference index
 
The following sections explain shortly what can be found in the left sidebar navigation menu.
 
# HyperFormula
 
This section contains information about the class for creating HyperFormula instance. It enlists all available public methods alongside their descriptions, parameter types, and examples.
 
The snippet shows an example how to use buildFromArray which is one of three static methods for creating an instance of HyperFormula:
 
const sheetData = [
   ['0', '=SUM(1, 2, 3)', '52'],
   ['=SUM(A1:C1)', '', '=A1'],
   ['2', '=SUM(A1:C1)', '91'],
@@ -84,6 +84,6 @@
       
       →
- + \ No newline at end of file diff --git a/api/interfaces/configparams.html b/api/interfaces/configparams.html index 739ff650e..f731aff92 100644 --- a/api/interfaces/configparams.html +++ b/api/interfaces/configparams.html @@ -19,7 +19,7 @@ - + @@ -38,12 +38,12 @@ API Reference GitHub - (opens new window)

# ConfigParams Interface

# License

# licenseKey

• licenseKey: string

Defined in src/Config.ts:220 (opens new window)

Sets your HyperFormula license key.

To use HyperFormula on the GPLv3 license terms, set this option to gpl-v3.

To use HyperFormula with your commercial license, set this option to your valid license key string.

For more information, go here.

default undefined

# Engine

# binarySearchThreshold

• binarySearchThreshold: number

Defined in src/Config.ts:48 (opens new window)

Sets a minimum number of elements that a range must have to use binary search.

deprecated Every search of sorted data always uses binary search.

default 20

# chooseAddressMappingPolicy

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in src/Config.ts:83 (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

# evaluateNullToZero

• evaluateNullToZero: boolean

Defined in src/Config.ts:155 (opens new window)

When set to true, formulas evaluating to null evaluate to 0 instead.

default false

# maxColumns

• maxColumns: number

Defined in src/Config.ts:271 (opens new window)

Sets the maximum number of columns.

default 18.278 (Columns A, B, ..., ZZZ)

# maxRows

• maxRows: number

Defined in src/Config.ts:263 (opens new window)

Sets the maximum number of rows.

default 40.000

# useArrayArithmetic

• useArrayArithmetic: boolean

Defined in src/Config.ts:440 (opens new window)

When set to true, array arithmetic is enabled globally.

When set to false, array arithmetic is enabled only inside array functions (ARRAYFORMULA, FILTER, and ARRAY_CONSTRAIN).

For more information, see the Arrays guide.

default false

# useColumnIndex

• useColumnIndex: boolean

Defined in src/Config.ts:452 (opens new window)

When set to true, switches column search strategy from binary search to column index.

Using column index improves efficiency of the VLOOKUP and MATCH functions, but increases memory usage.

When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with useColumnIndex set to true).

default false

# useStats

• useStats: boolean

Defined in src/Config.ts:462 (opens new window)

When set to true, enables gathering engine statistics and timings.

Useful for testing and benchmarking.

default false

# Formula Syntax

# arrayColumnSeparator

• arrayColumnSeparator: "," | ";"

Defined in src/Config.ts:248 (opens new window)

Sets a column separator symbol for array notation.

default ','

# arrayRowSeparator

• arrayRowSeparator: ";" | "|"

Defined in src/Config.ts:255 (opens new window)

Sets a row separator symbol for array notation.

default ';'

# functionArgSeparator

• functionArgSeparator: string

Defined in src/Config.ts:131 (opens new window)

Sets a separator character that separates procedure arguments in formulas.

Must be different from decimalSeparator and thousandSeparator.

For more information, see the Internationalization features guide.

default ','

# functionPlugins

• functionPlugins: any[]

Defined in src/Config.ts:164 (opens new window)

Lists additional function plugins to be used by the formula interpreter.

default []

# ignoreWhiteSpace

• ignoreWhiteSpace: "standard" | "any"

Defined in src/Config.ts:194 (opens new window)

Controls the set of whitespace characters that are allowed inside a formula.

When set to 'standard', allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)

When set to 'any', allows all whitespace characters that would be captured by the \s character class of the JavaScript regular expressions.

default 'standard'

# language

• language: string

Defined in src/Config.ts:182 (opens new window)

Sets a translation package for function and error names.

For more information, see the Localizing functions guide.

default 'enGB'

# Undo and Redo

# undoLimit

• undoLimit: number

Defined in src/Config.ts:470 (opens new window)

Sets the number of elements kept in the undo history.

default 20

# Date and Time

# dateFormats

• dateFormats: string[]

Defined in src/Config.ts:119 (opens new window)

Sets the date formats accepted by the date-parsing function.

A format must be specified as a string consisting of tokens and separators.

Supported tokens:

  • DD (day of month)
  • MM (month as a number)
  • YYYY (year as a 4-digit number)
  • YY (year as a 2-digit number)

Supported separators:

  • / (slash)
  • - (dash)
  • . (dot)
  • (empty space)

Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.

For more information, see the Date and time handling guide.

default ['DD/MM/YYYY', 'DD/MM/YY']

# leapYear1900

• leapYear1900: boolean

Defined in src/Config.ts:206 (opens new window)

Sets year 1900 as a leap year.

For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to true.

For more information, see nullDate.

default false

# nullDate

• nullDate: SimpleDate

Defined in src/Config.ts:283 (opens new window)

Internally, each date is represented as a number of days that passed since nullDate.

This option sets a specific date from which that number of days is counted.

For more information, see the Date and time handling guide.

default {year: 1899, month: 12, day: 30}

# nullYear

• nullYear: number

Defined in src/Config.ts:297 (opens new window)

Sets the interpretation of two-digit year values.

Two-digit year values (xx) can either become 19xx or 20xx.

If xx is less or equal to nullYear, two-digit year values become 20xx.

If xx is more than nullYear, two-digit year values become 19xx.

default 30

# parseDateTime

• parseDateTime: function

Defined in src/Config.ts:309 (opens new window)

Sets a function that parses strings representing date-time into actual date-time values.

The function should return a DateTime object or undefined.

For more information, see the Date and time handling guide.

default defaultParseToDateTime

# Type declaration:

▸ (dateTimeString: string, dateFormat?: undefined | string, timeFormat?: undefined | string): Maybe‹DateTime›

Parameters:

Name Type
dateTimeString string
dateFormat? undefined | string
timeFormat? undefined | string

# stringifyDateTime

• stringifyDateTime: function

Defined in src/Config.ts:355 (opens new window)

Sets a function that converts date-time values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDateTime

# Type declaration:

▸ (dateTime: SimpleDateTime, dateTimeFormat: string): Maybe‹string›

Parameters:

Name Type
dateTime SimpleDateTime
dateTimeFormat string

# stringifyDuration

• stringifyDuration: function

Defined in src/Config.ts:367 (opens new window)

Sets a function that converts time duration values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDuration

# Type declaration:

▸ (time: SimpleTime, timeFormat: string): Maybe‹string›

Parameters:

Name Type
time SimpleTime
timeFormat string

# timeFormats

• timeFormats: string[]

Defined in src/Config.ts:428 (opens new window)

Sets the time formats accepted by the time-parsing function.

A format must be specified as a string consisting of at least two tokens separated by : (a colon).

Supported tokens:

  • hh (hours)
  • mm (minutes)
  • ss, ss.s, ss.ss, ss.sss, ss.ssss, etc. (seconds)

The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values. + (opens new window)

# ConfigParams Interface

# License

# licenseKey

• licenseKey: string

Defined in src/Config.ts:220 (opens new window)

Sets your HyperFormula license key.

To use HyperFormula on the GPLv3 license terms, set this option to gpl-v3.

To use HyperFormula with your commercial license, set this option to your valid license key string.

For more information, go here.

default undefined

# Engine

# binarySearchThreshold

• binarySearchThreshold: number

Defined in src/Config.ts:48 (opens new window)

Sets a minimum number of elements that a range must have to use binary search.

deprecated Every search of sorted data always uses binary search.

default 20

# chooseAddressMappingPolicy

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in src/Config.ts:83 (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

# evaluateNullToZero

• evaluateNullToZero: boolean

Defined in src/Config.ts:155 (opens new window)

When set to true, formulas evaluating to null evaluate to 0 instead.

default false

# maxColumns

• maxColumns: number

Defined in src/Config.ts:271 (opens new window)

Sets the maximum number of columns.

default 18.278 (Columns A, B, ..., ZZZ)

# maxRows

• maxRows: number

Defined in src/Config.ts:263 (opens new window)

Sets the maximum number of rows.

default 40.000

# useArrayArithmetic

• useArrayArithmetic: boolean

Defined in src/Config.ts:440 (opens new window)

When set to true, array arithmetic is enabled globally.

When set to false, array arithmetic is enabled only inside array functions (ARRAYFORMULA, FILTER, and ARRAY_CONSTRAIN).

For more information, see the Arrays guide.

default false

# useColumnIndex

• useColumnIndex: boolean

Defined in src/Config.ts:452 (opens new window)

When set to true, switches column search strategy from binary search to column index.

Using column index improves efficiency of the VLOOKUP and MATCH functions, but increases memory usage.

When searching with wildcards or regular expressions, column search strategy falls back to binary search (even with useColumnIndex set to true).

default false

# useStats

• useStats: boolean

Defined in src/Config.ts:462 (opens new window)

When set to true, enables gathering engine statistics and timings.

Useful for testing and benchmarking.

default false

# Formula Syntax

# arrayColumnSeparator

• arrayColumnSeparator: "," | ";"

Defined in src/Config.ts:248 (opens new window)

Sets a column separator symbol for array notation.

default ','

# arrayRowSeparator

• arrayRowSeparator: ";" | "|"

Defined in src/Config.ts:255 (opens new window)

Sets a row separator symbol for array notation.

default ';'

# functionArgSeparator

• functionArgSeparator: string

Defined in src/Config.ts:131 (opens new window)

Sets a separator character that separates procedure arguments in formulas.

Must be different from decimalSeparator and thousandSeparator.

For more information, see the Internationalization features guide.

default ','

# functionPlugins

• functionPlugins: any[]

Defined in src/Config.ts:164 (opens new window)

Lists additional function plugins to be used by the formula interpreter.

default []

# ignoreWhiteSpace

• ignoreWhiteSpace: "standard" | "any"

Defined in src/Config.ts:194 (opens new window)

Controls the set of whitespace characters that are allowed inside a formula.

When set to 'standard', allows only SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D) (compliant with OpenFormula Standard 1.3)

When set to 'any', allows all whitespace characters that would be captured by the \s character class of the JavaScript regular expressions.

default 'standard'

# language

• language: string

Defined in src/Config.ts:182 (opens new window)

Sets a translation package for function and error names.

For more information, see the Localizing functions guide.

default 'enGB'

# Undo and Redo

# undoLimit

• undoLimit: number

Defined in src/Config.ts:470 (opens new window)

Sets the number of elements kept in the undo history.

default 20

# Date and Time

# dateFormats

• dateFormats: string[]

Defined in src/Config.ts:119 (opens new window)

Sets the date formats accepted by the date-parsing function.

A format must be specified as a string consisting of tokens and separators.

Supported tokens:

  • DD (day of month)
  • MM (month as a number)
  • YYYY (year as a 4-digit number)
  • YY (year as a 2-digit number)

Supported separators:

  • / (slash)
  • - (dash)
  • . (dot)
  • (empty space)

Regardless of the separator specified in the format string, all of the above are accepted by the date-parsing function.

For more information, see the Date and time handling guide.

default ['DD/MM/YYYY', 'DD/MM/YY']

# leapYear1900

• leapYear1900: boolean

Defined in src/Config.ts:206 (opens new window)

Sets year 1900 as a leap year.

For compatibility with Lotus 1-2-3 and Microsoft Excel, set this option to true.

For more information, see nullDate.

default false

# nullDate

• nullDate: SimpleDate

Defined in src/Config.ts:283 (opens new window)

Internally, each date is represented as a number of days that passed since nullDate.

This option sets a specific date from which that number of days is counted.

For more information, see the Date and time handling guide.

default {year: 1899, month: 12, day: 30}

# nullYear

• nullYear: number

Defined in src/Config.ts:297 (opens new window)

Sets the interpretation of two-digit year values.

Two-digit year values (xx) can either become 19xx or 20xx.

If xx is less or equal to nullYear, two-digit year values become 20xx.

If xx is more than nullYear, two-digit year values become 19xx.

default 30

# parseDateTime

• parseDateTime: function

Defined in src/Config.ts:309 (opens new window)

Sets a function that parses strings representing date-time into actual date-time values.

The function should return a DateTime object or undefined.

For more information, see the Date and time handling guide.

default defaultParseToDateTime

# Type declaration:

▸ (dateTimeString: string, dateFormat?: undefined | string, timeFormat?: undefined | string): Maybe‹DateTime›

Parameters:

Name Type
dateTimeString string
dateFormat? undefined | string
timeFormat? undefined | string

# stringifyDateTime

• stringifyDateTime: function

Defined in src/Config.ts:355 (opens new window)

Sets a function that converts date-time values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDateTime

# Type declaration:

▸ (dateTime: SimpleDateTime, dateTimeFormat: string): Maybe‹string›

Parameters:

Name Type
dateTime SimpleDateTime
dateTimeFormat string

# stringifyDuration

• stringifyDuration: function

Defined in src/Config.ts:367 (opens new window)

Sets a function that converts time duration values into strings.

The function should return a string or undefined.

For more information, see the Date and time handling guide.

default defaultStringifyDuration

# Type declaration:

▸ (time: SimpleTime, timeFormat: string): Maybe‹string›

Parameters:

Name Type
time SimpleTime
timeFormat string

# timeFormats

• timeFormats: string[]

Defined in src/Config.ts:428 (opens new window)

Sets the time formats accepted by the time-parsing function.

A format must be specified as a string consisting of at least two tokens separated by : (a colon).

Supported tokens:

  • hh (hours)
  • mm (minutes)
  • ss, ss.s, ss.ss, ss.sss, ss.ssss, etc. (seconds)

The number of decimal places in the seconds token does not matter. All versions of the seconds token are equivalent in the context of parsing time values. Regardless of the time format specified, the hours-minutes-seconds value may be followed by the AM/PM designator.

For more information, see the Date and time handling guide.

example -E.g. for timeFormats = ['hh:mm:ss.sss'], valid time strings include:

  • 1:33:33
  • 1:33:33.3
  • 1:33:33.33
  • 1:33:33.333
  • 01:33:33
  • 1:33:33 AM
  • 1:33:33 PM
  • 1:33:33 am
  • 1:33:33 pm
  • 1:33:33AM
  • 1:33:33PM

default ['hh:mm', 'hh:mm:ss.sss']

# Number

# currencySymbol

• currencySymbol: string[]

Defined in src/Config.ts:93 (opens new window)

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default ['$']

# decimalSeparator

• decimalSeparator: "." | ","

Defined in src/Config.ts:147 (opens new window)

Sets a decimal separator used for parsing numerical literals.

Can be one of the following:

  • . (period)
  • , (comma)

Must be different from thousandSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default '.'

# precisionEpsilon

• precisionEpsilon: number

Defined in src/Config.ts:326 (opens new window)

Sets how far two numerical values need to be from each other to be treated as non-equal.

a and b are equal if all three of the following conditions are met:

  • Both a and b are of the same sign
  • abs(a) <= (1+precisionEpsilon) * abs(b)
  • abs(b) <= (1+precisionEpsilon) * abs(a)

Additionally, this option controls the snap-to-zero behavior for additions and subtractions:

  • For c=a+b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0
  • For c=a-b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0

default 1e-13

# precisionRounding

• precisionRounding: number

Defined in src/Config.ts:343 (opens new window)

Sets the precision level of calculations' output.

Internally, all arithmetic operations are performed using JavaScript's built-in numbers. +E.g. for timeFormats = ['hh:mm:ss.sss'], valid time strings include:

  • 1:33:33
  • 1:33:33.3
  • 1:33:33.33
  • 1:33:33.333
  • 01:33:33
  • 1:33:33 AM
  • 1:33:33 PM
  • 1:33:33 am
  • 1:33:33 pm
  • 1:33:33AM
  • 1:33:33PM

default ['hh:mm', 'hh:mm:ss.sss']

# Number

# currencySymbol

• currencySymbol: string[]

Defined in src/Config.ts:93 (opens new window)

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default ['$']

# decimalSeparator

• decimalSeparator: "." | ","

Defined in src/Config.ts:147 (opens new window)

Sets a decimal separator used for parsing numerical literals.

Can be one of the following:

  • . (period)
  • , (comma)

Must be different from thousandSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default '.'

# precisionEpsilon

• precisionEpsilon: number

Defined in src/Config.ts:326 (opens new window)

Sets how far two numerical values need to be from each other to be treated as non-equal.

a and b are equal if all three of the following conditions are met:

  • Both a and b are of the same sign
  • abs(a) <= (1+precisionEpsilon) * abs(b)
  • abs(b) <= (1+precisionEpsilon) * abs(a)

Additionally, this option controls the snap-to-zero behavior for additions and subtractions:

  • For c=a+b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0
  • For c=a-b, if abs(c) <= precisionEpsilon * abs(a), then c is set to 0

default 1e-13

# precisionRounding

• precisionRounding: number

Defined in src/Config.ts:343 (opens new window)

Sets the precision level of calculations' output.

Internally, all arithmetic operations are performed using JavaScript's built-in numbers. But when HyperFormula exports a cell's value, it rounds the output to the precisionRounding number of significant digits.

Setting precisionRounding too low can cause large numbers' imprecision -(for example, with precisionRounding set to 4, 100005 becomes 100010).

We recommend setting precisionRounding to a value between 10 and 14.

default 14

# smartRounding

• smartRounding: boolean

Defined in src/Config.ts:377 (opens new window)

When set to false, no rounding happens, and numbers are equal if and only if they are of truly identical value.

For more information, see precisionEpsilon.

default true

# thousandSeparator

• thousandSeparator: "" | "," | " " | "."

Defined in src/Config.ts:394 (opens new window)

Sets the thousands' separator symbol for parsing numerical literals.

Can be one of the following:

  • empty
  • , (comma)
  • (empty space)

Must be different from decimalSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default ''

# String

# accentSensitive

• accentSensitive: boolean

Defined in src/Config.ts:38 (opens new window)

When set to true, makes string comparison accent-sensitive.

Applies only to comparison operators.

default false

# caseFirst

• caseFirst: "upper" | "lower" | "false"

Defined in src/Config.ts:70 (opens new window)

When set to upper, upper case sorts first.

When set to lower, lower case sorts first.

When set to false, uses the locale's default.

default 'lower'

# caseSensitive

• caseSensitive: boolean

Defined in src/Config.ts:58 (opens new window)

When set to true, makes string comparison case-sensitive.

Applies to comparison operators only.

default false

# ignorePunctuation

• ignorePunctuation: boolean

Defined in src/Config.ts:172 (opens new window)

When set to true, string comparison ignores punctuation.

default false

# localeLang

• localeLang: string

Defined in src/Config.ts:232 (opens new window)

Sets the locale for language-sensitive string comparison.

Accepts IETF BCP 47 language tags.

For more information, see the Internationalization features guide.

default 'en'

# matchWholeCell

• matchWholeCell: boolean

Defined in src/Config.ts:241 (opens new window)

When set to true, function criteria require whole cells to match the pattern.

When set to false, function criteria require just a sub-word to match the pattern.

default true

# useRegularExpressions

• useRegularExpressions: boolean

Defined in src/Config.ts:477 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.

default false

# useWildcards

• useWildcards: boolean

Defined in src/Config.ts:484 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) can use the * and ? wildcards.

default true

+(for example, with precisionRounding set to 4, 100005 becomes 100010).

We recommend setting precisionRounding to a value between 10 and 14.

default 14

# smartRounding

• smartRounding: boolean

Defined in src/Config.ts:377 (opens new window)

When set to false, no rounding happens, and numbers are equal if and only if they are of truly identical value.

For more information, see precisionEpsilon.

default true

# thousandSeparator

• thousandSeparator: "" | "," | " " | "."

Defined in src/Config.ts:394 (opens new window)

Sets the thousands' separator symbol for parsing numerical literals.

Can be one of the following:

  • empty
  • , (comma)
  • (empty space)

Must be different from decimalSeparator and functionArgSeparator.

For more information, see the Internationalization features guide.

default ''

# String

# accentSensitive

• accentSensitive: boolean

Defined in src/Config.ts:38 (opens new window)

When set to true, makes string comparison accent-sensitive.

Applies only to comparison operators.

default false

# caseFirst

• caseFirst: "upper" | "lower" | "false"

Defined in src/Config.ts:70 (opens new window)

When set to upper, upper case sorts first.

When set to lower, lower case sorts first.

When set to false, uses the locale's default.

default 'lower'

# caseSensitive

• caseSensitive: boolean

Defined in src/Config.ts:58 (opens new window)

When set to true, makes string comparison case-sensitive.

Applies to comparison operators only.

default false

# ignorePunctuation

• ignorePunctuation: boolean

Defined in src/Config.ts:172 (opens new window)

When set to true, string comparison ignores punctuation.

default false

# localeLang

• localeLang: string

Defined in src/Config.ts:232 (opens new window)

Sets the locale for language-sensitive string comparison.

Accepts IETF BCP 47 language tags.

For more information, see the Internationalization features guide.

default 'en'

# matchWholeCell

• matchWholeCell: boolean

Defined in src/Config.ts:241 (opens new window)

When set to true, function criteria require whole cells to match the pattern.

When set to false, function criteria require just a sub-word to match the pattern.

default true

# useRegularExpressions

• useRegularExpressions: boolean

Defined in src/Config.ts:477 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) are allowed to use regular expressions.

default false

# useWildcards

• useWildcards: boolean

Defined in src/Config.ts:484 (opens new window)

When set to true, criteria in functions (SUMIF, COUNTIF, ...) can use the * and ? wildcards.

default true

← →

- + \ No newline at end of file diff --git a/api/interfaces/listeners.html b/api/interfaces/listeners.html index 0eb38373c..b81fa909a 100644 --- a/api/interfaces/listeners.html +++ b/api/interfaces/listeners.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# Listeners Interface

# Batch

# evaluationResumed

• evaluationResumed: function

Defined in src/Emitter.ts:316 (opens new window)

Occurs when evaluation is resumed.

param the values and location of applied changes

example

const hfInstance = HyperFormula.buildFromSheets({
+     (opens new window)    
 
# Listeners Interface
 
# Batch
 
# evaluationResumed
 
• evaluationResumed: function
 
Defined in src/Emitter.ts:316 (opens new window)
 
Occurs when evaluation is resumed.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ]
 });
@@ -65,7 +65,7 @@
 // resume evaluation again
 // this time, the console doesn't print anything
 hfInstance.resumeEvaluation();;
-
# Type declaration:
 
▸ (changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
changes ExportedChange[]
 
 
# evaluationSuspended
 
• evaluationSuspended: function
 
Defined in src/Emitter.ts:274 (opens new window)
 
Occurs when evaluation is suspended.
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
changes ExportedChange[]
 
 
# evaluationSuspended
 
• evaluationSuspended: function
 
Defined in src/Emitter.ts:274 (opens new window)
 
Occurs when evaluation is suspended.
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['1'] ],
   MySheet2: [ ['10'] ]
 });
@@ -89,7 +89,7 @@
 // suspend evaluation again
 // this time, the console doesn't print anything
 hfInstance.suspendEvaluation();;
-
# Type declaration:
 
▸ (): any
 
 
# Named Expression
 
# namedExpressionAdded
 
• namedExpressionAdded: function
 
Defined in src/Emitter.ts:162 (opens new window)
 
Occurs when a named expression with specified values and location is added.
 
param the name of added expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (): any
 
 
# Named Expression
 
# namedExpressionAdded
 
• namedExpressionAdded: function
 
Defined in src/Emitter.ts:162 (opens new window)
 
Occurs when a named expression with specified values and location is added.
 
param the name of added expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['42'],
 ]);
 
@@ -109,7 +109,7 @@
 // add another named expression
 // this time, the console doesn't print anything
 const changes = hfInstance.addNamedExpression('uglyName', '=Sheet1!$A$1+100', 0);
-
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# namedExpressionRemoved
 
• namedExpressionRemoved: function
 
Defined in src/Emitter.ts:202 (opens new window)
 
Occurs when a named expression with specified values is removed and from an indicated location.
 
param the name of removed expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# namedExpressionRemoved
 
• namedExpressionRemoved: function
 
Defined in src/Emitter.ts:202 (opens new window)
 
Occurs when a named expression with specified values is removed and from an indicated location.
 
param the name of removed expression
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['42'],
 ]);
 
@@ -133,7 +133,7 @@
 // remove another named expression
 // this time, the console doesn't print anything
 const changes = hfInstance.removeNamedExpression('uglyName', 0);
-
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# Sheet
 
# sheetAdded
 
• sheetAdded: function
 
Defined in src/Emitter.ts:52 (opens new window)
 
Occurs when a sheet is added anywhere inside the workbook.
 
param the name of added sheet
 
example
 
const hfInstance = HyperFormula.buildEmpty();
+
# Type declaration:
 
▸ (namedExpressionName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
namedExpressionName string
 
changes ExportedChange[]
 
 
# Sheet
 
# sheetAdded
 
• sheetAdded: function
 
Defined in src/Emitter.ts:52 (opens new window)
 
Occurs when a sheet is added anywhere inside the workbook.
 
param the name of added sheet
 
example
 
const hfInstance = HyperFormula.buildEmpty();
 
 // define a function to be called when the event occurs
 const handler = (addedSheetDisplayName) => { console.log('baz') }
@@ -151,7 +151,7 @@
 // add a sheet
 // this time, the console doesn't print anything
 hfInstance.addSheet('FooBaz');
-
# Type declaration:
 
▸ (addedSheetDisplayName: string): any
 
Parameters:
 
Name Type
 
addedSheetDisplayName string
 
 
# sheetRemoved
 
• sheetRemoved: function
 
Defined in src/Emitter.ts:89 (opens new window)
 
Occurs when a sheet is removed from anywhere inside the workbook.
 
param the name of removed sheet
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (addedSheetDisplayName: string): any
 
Parameters:
 
Name Type
 
addedSheetDisplayName string
 
 
# sheetRemoved
 
• sheetRemoved: function
 
Defined in src/Emitter.ts:89 (opens new window)
 
Occurs when a sheet is removed from anywhere inside the workbook.
 
param the name of removed sheet
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
   MySheet2: [ ['10'] ],
 });
@@ -172,7 +172,7 @@
 // remove a sheet
 // this time, the console doesn't print anything
 hfInstance.removeSheet(1);
-
# Type declaration:
 
▸ (removedSheetDisplayName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
removedSheetDisplayName string
 
changes ExportedChange[]
 
 
# sheetRenamed
 
• sheetRenamed: function
 
Defined in src/Emitter.ts:126 (opens new window)
 
Occurs when a sheet is renamed anywhere inside the workbook.
 
param the old name of a sheet before renaming
 
param the new name of the sheet after renaming
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
+
# Type declaration:
 
▸ (removedSheetDisplayName: string, changes: ExportedChange[]): any
 
Parameters:
 
Name Type
 
removedSheetDisplayName string
 
changes ExportedChange[]
 
 
# sheetRenamed
 
• sheetRenamed: function
 
Defined in src/Emitter.ts:126 (opens new window)
 
Occurs when a sheet is renamed anywhere inside the workbook.
 
param the old name of a sheet before renaming
 
param the new name of the sheet after renaming
 
example
 
const hfInstance = HyperFormula.buildFromSheets({
   MySheet1: [ ['=SUM(MySheet2!A1:A2)'] ],
   MySheet2: [ ['10'] ],
 });
@@ -193,7 +193,7 @@
 // rename a sheet
 // this time, the console doesn't print anything
 hfInstance.renameSheet(1, 'MySheet1');
-
# Type declaration:
 
▸ (oldDisplayName: string, newDisplayName: string): any
 
Parameters:
 
Name Type
 
oldDisplayName string
 
newDisplayName string
 
 
# Values
 
# valuesUpdated
 
• valuesUpdated: function
 
Defined in src/Emitter.ts:237 (opens new window)
 
Occurs when values in a specified location are changed and cause recalculation.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
+
# Type declaration:
 
▸ (oldDisplayName: string, newDisplayName: string): any
 
Parameters:
 
Name Type
 
oldDisplayName string
 
newDisplayName string
 
 
# Values
 
# valuesUpdated
 
• valuesUpdated: function
 
Defined in src/Emitter.ts:237 (opens new window)
 
Occurs when values in a specified location are changed and cause recalculation.
 
param the values and location of applied changes
 
example
 
const hfInstance = HyperFormula.buildFromArray([
   ['1', '2', '=A1'],
 ]);
 
@@ -218,6 +218,6 @@
- + \ No newline at end of file diff --git a/api/interfaces/typedemitter.html b/api/interfaces/typedemitter.html index 4fd2fcd40..6983da7f9 100644 --- a/api/interfaces/typedemitter.html +++ b/api/interfaces/typedemitter.html @@ -19,7 +19,7 @@ - + @@ -38,7 +38,7 @@ API Reference GitHub - (opens new window)

# TypedEmitter Interface

# Methods

# off

▸ off‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:322 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# on

▸ on‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:320 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# once

▸ once‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:324 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

- + (opens new window)

# TypedEmitter Interface

# Methods

# off

▸ off‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:322 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# on

▸ on‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:320 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

# once

▸ once‹Event›(s: Event, listener: Listeners[Event]): void

Defined in src/Emitter.ts:324 (opens new window)

Type parameters:

▪ Event: keyof Listeners

Parameters:

Name Type
s Event
listener Listeners[Event]

Returns: void

+ \ No newline at end of file diff --git a/assets/js/20.ddd11154.js b/assets/js/20.9ba2d709.js similarity index 99% rename from assets/js/20.ddd11154.js rename to assets/js/20.9ba2d709.js index fe7ac8f2f..53b58b03a 100644 --- a/assets/js/20.ddd11154.js +++ b/assets/js/20.9ba2d709.js @@ -676,7 +676,7 @@ * . * * Version: 2.6.0 - * Release date: 19/09/2023 (built at 19/09/2023 11:06:12) + * Release date: 19/09/2023 (built at 26/09/2023 14:21:35) */ var n;r(298),r(100),r(92),r(90),r(299),r(300),r(302),"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(74);t.CellError=o.CellError,t.CellType=o.CellType,t.CellValueDetailedType=o.CellValueDetailedType,t.CellValueType=o.CellValueType,t.ErrorType=o.ErrorType;var s=r(171);t.DetailedCellError=s.DetailedCellError;var i=r(172),a=r(176);t.AlwaysDense=a.AlwaysDense,t.AlwaysSparse=a.AlwaysSparse,t.DenseSparseChooseBasedOnThreshold=a.DenseSparseChooseBasedOnThreshold;var u=r(148);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(199);t.ExportedCellChange=c.ExportedCellChange,t.ExportedNamedExpressionChange=c.ExportedNamedExpressionChange;var l=r(181);t.HyperFormula=l.HyperFormula;var h,d=(h=r(217))&&h.__esModule?h:{default:h},p=r(218);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={},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(219)),g=r(140);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; /** @@ -936,7 +936,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) 2023 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.0",E.buildDate="19/09/2023 11:06:12",E.releaseDate="19/09/2023",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(183),s=r(184),i=r(172),a=r(185),u=r(175),c=r(75),l=r(148),h=r(198),d=r(199),p=r(200),m=r(159),g=r(168),f=r(201),E=r(203),T=r(205),y=r(207),A=r(186),R=r(212),N=r(187),S=r(78),C=r(213),v=r(196),O=r(143),I=r(197);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)}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.0",E.buildDate="26/09/2023 14:21:35",E.releaseDate="19/09/2023",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(183),s=r(184),i=r(172),a=r(185),u=r(175),c=r(75),l=r(148),h=r(198),d=r(199),p=r(200),m=r(159),g=r(168),f=r(201),E=r(203),T=r(205),y=r(207),A=r(186),R=r(212),N=r(187),S=r(78),C=r(213),v=r(196),O=r(143),I=r(197);t.BuildEngineFactory= /** * @license * Copyright (c) 2023 Handsoncode. All rights reserved. diff --git a/assets/js/27.4a6bda30.js b/assets/js/27.90d2b57e.js similarity index 91% rename from assets/js/27.4a6bda30.js rename to assets/js/27.90d2b57e.js index 746dd475d..ced3b64a2 100644 --- a/assets/js/27.4a6bda30.js +++ b/assets/js/27.90d2b57e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{321: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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{321: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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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.23c4a2c6.js b/assets/js/28.9adcddea.js similarity index 97% rename from assets/js/28.23c4a2c6.js rename to assets/js/28.9adcddea.js index aa4c0bebe..ae2ce04e5 100644 --- a/assets/js/28.23c4a2c6.js +++ b/assets/js/28.9adcddea.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{322: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/2864be8/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([[28],{322: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/50731c7/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.036cbae0.js b/assets/js/29.d5cf6270.js similarity index 98% rename from assets/js/29.036cbae0.js rename to assets/js/29.d5cf6270.js index 451da1ea5..bef36eeee 100644 --- a/assets/js/29.036cbae0.js +++ b/assets/js/29.d5cf6270.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\nale 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(" = '19/09/2023 11:06:12'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/2864be8/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/2864be8/src/HyperFormula.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:114"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Contains all available languages to use in registerLanguage.")]),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(" = '19/09/2023'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/2864be8/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.0'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/2864be8/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/2864be8/src/HyperFormula.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:153"),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/2864be8/src/HyperFormula.ts#L325",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:325"),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/2864be8/src/HyperFormula.ts#L265",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:265"),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/2864be8/src/HyperFormula.ts#L305",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:305"),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/2864be8/src/HyperFormula.ts#L4320",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4320"),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/2864be8/src/HyperFormula.ts#L1016",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1016"),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/2864be8/src/HyperFormula.ts#L1030",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1030"),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/2864be8/src/HyperFormula.ts#L995",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:995"),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/2864be8/src/HyperFormula.ts#L2538",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2538"),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/2864be8/src/HyperFormula.ts#L2681",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2681"),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("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/2864be8/src/HyperFormula.ts#L3314",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3314"),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/2864be8/src/HyperFormula.ts#L3037",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3037"),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/2864be8/src/HyperFormula.ts#L879",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:879"),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/2864be8/src/HyperFormula.ts#L948",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:948"),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/2864be8/src/HyperFormula.ts#L969",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:969"),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/2864be8/src/HyperFormula.ts#L929",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:929"),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/2864be8/src/HyperFormula.ts#L904",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:904"),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/2864be8/src/HyperFormula.ts#L816",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:816"),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/2864be8/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 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/2864be8/src/HyperFormula.ts#L2966",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2966"),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/2864be8/src/HyperFormula.ts#L2988",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2988"),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/2864be8/src/HyperFormula.ts#L849",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:849"),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/2864be8/src/HyperFormula.ts#L783",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:783"),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/2864be8/src/HyperFormula.ts#L2501",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2501"),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/2864be8/src/HyperFormula.ts#L2641",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2641"),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/2864be8/src/HyperFormula.ts#L2569",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2569"),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/2864be8/src/HyperFormula.ts#L3341",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3341"),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/2864be8/src/HyperFormula.ts#L2711",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2711"),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/2864be8/src/HyperFormula.ts#L2610",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2610"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a sheet")]),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/2864be8/src/HyperFormula.ts#L3377",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3377"),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/2864be8/src/HyperFormula.ts#L2746",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2746"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Replaces the sheet content with new values.")]),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/2864be8/src/HyperFormula.ts#L2457",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2457"),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/2864be8/src/HyperFormula.ts#L2387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2387"),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/2864be8/src/HyperFormula.ts#L2423",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2423"),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/2864be8/src/HyperFormula.ts#L2351",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2351"),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/2864be8/src/HyperFormula.ts#L1622",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1622"),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("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/2864be8/src/HyperFormula.ts#L1582",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1582"),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/2864be8/src/HyperFormula.ts#L1969",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1969"),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/2864be8/src/HyperFormula.ts#L1653",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1653"),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/2864be8/src/HyperFormula.ts#L1389",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1389"),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/2864be8/src/HyperFormula.ts#L1312",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1312"),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/2864be8/src/HyperFormula.ts#L2014",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2014"),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("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/2864be8/src/HyperFormula.ts#L1692",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1692"),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("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/2864be8/src/HyperFormula.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1358"),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("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/2864be8/src/HyperFormula.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1281"),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("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/2864be8/src/HyperFormula.ts#L1766",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1766"),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("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/2864be8/src/HyperFormula.ts#L1722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1722"),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/2864be8/src/HyperFormula.ts#L2049",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2049"),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/2864be8/src/HyperFormula.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1796"),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/2864be8/src/HyperFormula.ts#L1546",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1546"),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/2864be8/src/HyperFormula.ts#L1473",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1473"),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/2864be8/src/HyperFormula.ts#L2100",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2100"),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("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/2864be8/src/HyperFormula.ts#L1839",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1839"),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("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/2864be8/src/HyperFormula.ts#L1516",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1516"),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("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/2864be8/src/HyperFormula.ts#L1445",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1445"),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("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/2864be8/src/HyperFormula.ts#L3129",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3129"),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/2864be8/src/HyperFormula.ts#L3098",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3098"),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/2864be8/src/HyperFormula.ts#L689",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:689"),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/2864be8/src/HyperFormula.ts#L719",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:719"),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/2864be8/src/HyperFormula.ts#L751",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:751"),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/2864be8/src/HyperFormula.ts#L3066",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3066"),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/2864be8/src/HyperFormula.ts#L658",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:658"),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/2864be8/src/HyperFormula.ts#L3256",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3256"),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/2864be8/src/HyperFormula.ts#L3290",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3290"),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/2864be8/src/HyperFormula.ts#L3222",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3222"),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/2864be8/src/HyperFormula.ts#L3161",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3161"),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/2864be8/src/HyperFormula.ts#L3189",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3189"),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/2864be8/src/HyperFormula.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1875"),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/2864be8/src/HyperFormula.ts#L1180",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1180"),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/2864be8/src/HyperFormula.ts#L1930",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1930"),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("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/2864be8/src/HyperFormula.ts#L1231",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1231"),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("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/2864be8/src/HyperFormula.ts#L3603",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3603"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a specified named expression.")]),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/2864be8/src/HyperFormula.ts#L3817",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3817"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Changes a given named expression to a specified formula.")]),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/2864be8/src/HyperFormula.ts#L3979",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3979"),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/2864be8/src/HyperFormula.ts#L3722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3722"),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/2864be8/src/HyperFormula.ts#L3679",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3679"),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/2864be8/src/HyperFormula.ts#L3639",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3639"),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/2864be8/src/HyperFormula.ts#L3553",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3553"),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/2864be8/src/HyperFormula.ts#L3771",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3771"),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/2864be8/src/HyperFormula.ts#L3853",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3853"),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/2864be8/src/HyperFormula.ts#L3943",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3943"),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/2864be8/src/HyperFormula.ts#L3896",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3896"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a named expression.")]),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/2864be8/src/HyperFormula.ts#L4044",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4044"),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/2864be8/src/HyperFormula.ts#L2895",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2895"),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",[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/2864be8/src/HyperFormula.ts#L2931",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2931"),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",[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/2864be8/src/HyperFormula.ts#L4008",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4008"),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/2864be8/src/HyperFormula.ts#L4196",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4196"),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/2864be8/src/HyperFormula.ts#L4172",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4172"),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/2864be8/src/HyperFormula.ts#L4219",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4219"),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("sheetId")]),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/2864be8/src/HyperFormula.ts#L2781",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2781"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes simple (absolute) address of a cell address 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(" [[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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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("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("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/2864be8/src/HyperFormula.ts#L2833",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2833"),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/2864be8/src/HyperFormula.ts#L2808",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2808"),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/2864be8/src/HyperFormula.ts#L2864",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2864"),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/2864be8/src/HyperFormula.ts#L4073",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4073"),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/2864be8/src/HyperFormula.ts#L2270",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2270"),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/2864be8/src/HyperFormula.ts#L2136",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2136"),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/2864be8/src/HyperFormula.ts#L2174",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2174"),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/2864be8/src/HyperFormula.ts#L2253",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2253"),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/2864be8/src/HyperFormula.ts#L2221",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2221"),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("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/2864be8/src/HyperFormula.ts#L2298",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2298"),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/2864be8/src/HyperFormula.ts#L2323",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2323"),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/2864be8/src/HyperFormula.ts#L1148",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1148"),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/2864be8/src/HyperFormula.ts#L1131",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1131"),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/2864be8/src/HyperFormula.ts#L1105",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1105"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Re-do recently undone operation.")]),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/2864be8/src/HyperFormula.ts#L1071",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1071"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Undo the previous operation.")]),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/2864be8/src/HyperFormula.ts#L3415",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3415"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Runs multiple operations and recomputes formulas at the end.")]),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/2864be8/src/HyperFormula.ts#L3524",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3524"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if the dependency graph recalculation process is suspended or not.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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/2864be8/src/HyperFormula.ts#L3498",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3498"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Resumes the dependency graph recalculation that was suspended with "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#suspendevaluation"}},[t._v("suspendEvaluation")]),t._v(".\nIt also triggers the recalculation and returns changes that are a result of all batched operations.")],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/2864be8/src/HyperFormula.ts#L3462",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3462"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Suspends the dependency graph recalculation.\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/2864be8/src/HyperFormula.ts#L4305",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4305"),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/2864be8/src/HyperFormula.ts#L4245",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4245"),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/2864be8/src/HyperFormula.ts#L4271",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4271"),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/2864be8/src/HyperFormula.ts#L4148",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4148"),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/2864be8/src/HyperFormula.ts#L4130",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4130"),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/2864be8/src/HyperFormula.ts#L4102",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4102"),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/2864be8/src/HyperFormula.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:610"),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/2864be8/src/HyperFormula.ts#L594",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:594"),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/2864be8/src/HyperFormula.ts#L345",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:345"),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/2864be8/src/HyperFormula.ts#L566",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:566"),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/2864be8/src/HyperFormula.ts#L424",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:424"),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/2864be8/src/HyperFormula.ts#L502",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:502"),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/2864be8/src/HyperFormula.ts#L452",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:452"),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/2864be8/src/HyperFormula.ts#L376",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:376"),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/2864be8/src/HyperFormula.ts#L547",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:547"),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/2864be8/src/HyperFormula.ts#L530",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:530"),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/2864be8/src/HyperFormula.ts#L474",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:474"),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/2864be8/src/HyperFormula.ts#L404",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:404"),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([[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\nale 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(" = '26/09/2023 14:21:35'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/50731c7/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/50731c7/src/HyperFormula.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:114"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Contains all available languages to use in registerLanguage.")]),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(" = '19/09/2023'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/50731c7/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.0'")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/handsontable/hyperformula/blob/50731c7/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/50731c7/src/HyperFormula.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:153"),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/50731c7/src/HyperFormula.ts#L325",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:325"),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/50731c7/src/HyperFormula.ts#L265",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:265"),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/50731c7/src/HyperFormula.ts#L305",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:305"),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/50731c7/src/HyperFormula.ts#L4320",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4320"),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/50731c7/src/HyperFormula.ts#L1016",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1016"),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/50731c7/src/HyperFormula.ts#L1030",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1030"),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/50731c7/src/HyperFormula.ts#L995",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:995"),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/50731c7/src/HyperFormula.ts#L2538",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2538"),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/50731c7/src/HyperFormula.ts#L2681",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2681"),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("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/50731c7/src/HyperFormula.ts#L3314",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3314"),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/50731c7/src/HyperFormula.ts#L3037",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3037"),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/50731c7/src/HyperFormula.ts#L879",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:879"),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/50731c7/src/HyperFormula.ts#L948",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:948"),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/50731c7/src/HyperFormula.ts#L969",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:969"),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/50731c7/src/HyperFormula.ts#L929",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:929"),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/50731c7/src/HyperFormula.ts#L904",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:904"),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/50731c7/src/HyperFormula.ts#L816",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:816"),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/50731c7/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 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/50731c7/src/HyperFormula.ts#L2966",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2966"),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/50731c7/src/HyperFormula.ts#L2988",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2988"),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/50731c7/src/HyperFormula.ts#L849",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:849"),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/50731c7/src/HyperFormula.ts#L783",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:783"),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/50731c7/src/HyperFormula.ts#L2501",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2501"),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/50731c7/src/HyperFormula.ts#L2641",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2641"),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/50731c7/src/HyperFormula.ts#L2569",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2569"),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/50731c7/src/HyperFormula.ts#L3341",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3341"),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/50731c7/src/HyperFormula.ts#L2711",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2711"),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/50731c7/src/HyperFormula.ts#L2610",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2610"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a sheet")]),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/50731c7/src/HyperFormula.ts#L3377",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3377"),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/50731c7/src/HyperFormula.ts#L2746",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2746"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Replaces the sheet content with new values.")]),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/50731c7/src/HyperFormula.ts#L2457",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2457"),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/50731c7/src/HyperFormula.ts#L2387",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2387"),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/50731c7/src/HyperFormula.ts#L2423",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2423"),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/50731c7/src/HyperFormula.ts#L2351",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2351"),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/50731c7/src/HyperFormula.ts#L1622",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1622"),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("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/50731c7/src/HyperFormula.ts#L1582",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1582"),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/50731c7/src/HyperFormula.ts#L1969",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1969"),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/50731c7/src/HyperFormula.ts#L1653",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1653"),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/50731c7/src/HyperFormula.ts#L1389",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1389"),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/50731c7/src/HyperFormula.ts#L1312",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1312"),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/50731c7/src/HyperFormula.ts#L2014",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2014"),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("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/50731c7/src/HyperFormula.ts#L1692",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1692"),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("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/50731c7/src/HyperFormula.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1358"),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("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/50731c7/src/HyperFormula.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1281"),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("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/50731c7/src/HyperFormula.ts#L1766",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1766"),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("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/50731c7/src/HyperFormula.ts#L1722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1722"),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/50731c7/src/HyperFormula.ts#L2049",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2049"),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/50731c7/src/HyperFormula.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1796"),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/50731c7/src/HyperFormula.ts#L1546",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1546"),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/50731c7/src/HyperFormula.ts#L1473",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1473"),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/50731c7/src/HyperFormula.ts#L2100",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2100"),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("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/50731c7/src/HyperFormula.ts#L1839",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1839"),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("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/50731c7/src/HyperFormula.ts#L1516",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1516"),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("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/50731c7/src/HyperFormula.ts#L1445",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1445"),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("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/50731c7/src/HyperFormula.ts#L3129",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3129"),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/50731c7/src/HyperFormula.ts#L3098",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3098"),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/50731c7/src/HyperFormula.ts#L689",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:689"),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/50731c7/src/HyperFormula.ts#L719",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:719"),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/50731c7/src/HyperFormula.ts#L751",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:751"),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/50731c7/src/HyperFormula.ts#L3066",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3066"),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/50731c7/src/HyperFormula.ts#L658",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:658"),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/50731c7/src/HyperFormula.ts#L3256",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3256"),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/50731c7/src/HyperFormula.ts#L3290",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3290"),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/50731c7/src/HyperFormula.ts#L3222",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3222"),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/50731c7/src/HyperFormula.ts#L3161",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3161"),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/50731c7/src/HyperFormula.ts#L3189",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3189"),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/50731c7/src/HyperFormula.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1875"),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/50731c7/src/HyperFormula.ts#L1180",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1180"),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/50731c7/src/HyperFormula.ts#L1930",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1930"),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("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/50731c7/src/HyperFormula.ts#L1231",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1231"),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("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/50731c7/src/HyperFormula.ts#L3603",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3603"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Adds a specified named expression.")]),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/50731c7/src/HyperFormula.ts#L3817",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3817"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Changes a given named expression to a specified formula.")]),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/50731c7/src/HyperFormula.ts#L3979",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3979"),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/50731c7/src/HyperFormula.ts#L3722",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3722"),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/50731c7/src/HyperFormula.ts#L3679",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3679"),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/50731c7/src/HyperFormula.ts#L3639",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3639"),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/50731c7/src/HyperFormula.ts#L3553",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3553"),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/50731c7/src/HyperFormula.ts#L3771",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3771"),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/50731c7/src/HyperFormula.ts#L3853",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3853"),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/50731c7/src/HyperFormula.ts#L3943",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3943"),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/50731c7/src/HyperFormula.ts#L3896",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3896"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Removes a named expression.")]),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/50731c7/src/HyperFormula.ts#L4044",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4044"),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/50731c7/src/HyperFormula.ts#L2895",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2895"),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",[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/50731c7/src/HyperFormula.ts#L2931",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2931"),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",[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/50731c7/src/HyperFormula.ts#L4008",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4008"),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/50731c7/src/HyperFormula.ts#L4196",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4196"),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/50731c7/src/HyperFormula.ts#L4172",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4172"),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/50731c7/src/HyperFormula.ts#L4219",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4219"),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("sheetId")]),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/50731c7/src/HyperFormula.ts#L2781",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2781"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Computes simple (absolute) address of a cell address 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(" [[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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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(" simpleCellAddressTwo "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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("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("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/50731c7/src/HyperFormula.ts#L2833",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2833"),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/50731c7/src/HyperFormula.ts#L2808",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2808"),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/50731c7/src/HyperFormula.ts#L2864",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2864"),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/50731c7/src/HyperFormula.ts#L4073",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4073"),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/50731c7/src/HyperFormula.ts#L2270",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2270"),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/50731c7/src/HyperFormula.ts#L2136",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2136"),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/50731c7/src/HyperFormula.ts#L2174",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2174"),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/50731c7/src/HyperFormula.ts#L2253",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2253"),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/50731c7/src/HyperFormula.ts#L2221",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2221"),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("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/50731c7/src/HyperFormula.ts#L2298",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2298"),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/50731c7/src/HyperFormula.ts#L2323",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:2323"),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/50731c7/src/HyperFormula.ts#L1148",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1148"),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/50731c7/src/HyperFormula.ts#L1131",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1131"),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/50731c7/src/HyperFormula.ts#L1105",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1105"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Re-do recently undone operation.")]),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/50731c7/src/HyperFormula.ts#L1071",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:1071"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Undo the previous operation.")]),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/50731c7/src/HyperFormula.ts#L3415",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3415"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Runs multiple operations and recomputes formulas at the end.")]),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/50731c7/src/HyperFormula.ts#L3524",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3524"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Checks if the dependency graph recalculation process is suspended or not.")]),t._v(" "),s("p",[s("strong",[s("code",[t._v("example")])])]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hfInstance "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._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/50731c7/src/HyperFormula.ts#L3498",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3498"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Resumes the dependency graph recalculation that was suspended with "),s("RouterLink",{attrs:{to:"/api/classes/hyperformula.html#suspendevaluation"}},[t._v("suspendEvaluation")]),t._v(".\nIt also triggers the recalculation and returns changes that are a result of all batched operations.")],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/50731c7/src/HyperFormula.ts#L3462",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:3462"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("Suspends the dependency graph recalculation.\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/50731c7/src/HyperFormula.ts#L4305",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4305"),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/50731c7/src/HyperFormula.ts#L4245",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4245"),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/50731c7/src/HyperFormula.ts#L4271",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4271"),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/50731c7/src/HyperFormula.ts#L4148",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4148"),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/50731c7/src/HyperFormula.ts#L4130",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4130"),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/50731c7/src/HyperFormula.ts#L4102",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:4102"),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/50731c7/src/HyperFormula.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:610"),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/50731c7/src/HyperFormula.ts#L594",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:594"),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/50731c7/src/HyperFormula.ts#L345",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:345"),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/50731c7/src/HyperFormula.ts#L566",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:566"),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/50731c7/src/HyperFormula.ts#L424",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:424"),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/50731c7/src/HyperFormula.ts#L502",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:502"),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/50731c7/src/HyperFormula.ts#L452",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:452"),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/50731c7/src/HyperFormula.ts#L376",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:376"),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/50731c7/src/HyperFormula.ts#L547",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:547"),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/50731c7/src/HyperFormula.ts#L530",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:530"),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/50731c7/src/HyperFormula.ts#L474",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:474"),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/50731c7/src/HyperFormula.ts#L404",target:"_blank",rel:"noopener noreferrer"}},[t._v("src/HyperFormula.ts:404"),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.7a8e4244.js b/assets/js/30.84bd35fa.js similarity index 87% rename from assets/js/30.7a8e4244.js rename to assets/js/30.84bd35fa.js index becc76e0b..930e4ab3d 100644 --- a/assets/js/30.7a8e4244.js +++ b/assets/js/30.84bd35fa.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{324: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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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([[30],{324: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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/31.07d6f9e1.js b/assets/js/31.65831de1.js similarity index 92% rename from assets/js/31.07d6f9e1.js rename to assets/js/31.65831de1.js index cb3044c82..5237b07a5 100644 --- a/assets/js/31.07d6f9e1.js +++ b/assets/js/31.65831de1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{325: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/2864be8/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/2864be8/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/2864be8/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/2864be8/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{325: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/50731c7/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/50731c7/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/50731c7/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/50731c7/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.c8eaf785.js b/assets/js/32.a87e3718.js similarity index 93% rename from assets/js/32.c8eaf785.js rename to assets/js/32.a87e3718.js index 14bdbf03b..52709ec2f 100644 --- a/assets/js/32.c8eaf785.js +++ b/assets/js/32.a87e3718.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{326: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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{326: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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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.4f87b85a.js b/assets/js/33.73a3e5e1.js similarity index 98% rename from assets/js/33.4f87b85a.js rename to assets/js/33.73a3e5e1.js index ba2bea3ac..e7461ef92 100644 --- a/assets/js/33.4f87b85a.js +++ b/assets/js/33.73a3e5e1.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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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/2864be8/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([[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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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/50731c7/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.3cd892b8.js b/assets/js/34.00310178.js similarity index 92% rename from assets/js/34.3cd892b8.js rename to assets/js/34.00310178.js index cf8bd8af3..130c1eb93 100644 --- a/assets/js/34.3cd892b8.js +++ b/assets/js/34.00310178.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{328: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/2864be8/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/2864be8/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/2864be8/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([[34],{328: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/50731c7/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/50731c7/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/50731c7/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/59.de74e2ec.js b/assets/js/59.5c5fcba6.js similarity index 95% rename from assets/js/59.de74e2ec.js rename to assets/js/59.5c5fcba6.js index e7886cd65..dd6c0fee9 100644 --- a/assets/js/59.de74e2ec.js +++ b/assets/js/59.5c5fcba6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{353:function(t,a,e){"use strict";e.r(a);var o=e(14),i=Object(o.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integration-with-angular"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integration-with-angular"}},[t._v("#")]),t._v(" Integration with Angular")]),t._v(" "),a("p",[t._v("The installation process for applications written in Angular is the\nsame as in the case of VanillaJS. You can check the\n"),a("RouterLink",{attrs:{to:"/guide/client-side-installation.html"}},[t._v("client-side installation")]),t._v(" section for\nmore details.")],1),t._v(" "),a("h2",{attrs:{id:"demo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),a("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.4.x/angular-demo?autoresize=1\n &fontsize=11&hidenavigation=1&theme=light&view=preview",title:"handsontable/hyperformula-demos: angular-demo",allow:"accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking",sandbox:"allow-autoplay allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"}})])}),[],!1,null,null,null);a.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{353:function(t,a,e){"use strict";e.r(a);var o=e(14),i=Object(o.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integration-with-angular"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integration-with-angular"}},[t._v("#")]),t._v(" Integration with Angular")]),t._v(" "),a("p",[t._v("The installation process for applications written in Angular is the\nsame as in the case of VanillaJS. You can check the\n"),a("RouterLink",{attrs:{to:"/guide/client-side-installation.html"}},[t._v("client-side installation")]),t._v(" section for\nmore details.")],1),t._v(" "),a("h2",{attrs:{id:"demo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#demo"}},[t._v("#")]),t._v(" Demo")]),t._v(" "),a("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/angular-demo?autoresize=1\n &fontsize=11&hidenavigation=1&theme=light&view=preview",title:"handsontable/hyperformula-demos: angular-demo",allow:"accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking",sandbox:"allow-autoplay allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"}})])}),[],!1,null,null,null);a.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/app.23172200.js b/assets/js/app.c36aa3b2.js similarity index 97% rename from assets/js/app.23172200.js rename to assets/js/app.c36aa3b2.js index a0607be24..2c4d023a4 100644 --- a/assets/js/app.23172200.js +++ b/assets/js/app.c36aa3b2.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(e){function t(t){for(var r,a,l=t[0],s=t[1],u=t[2],f=0,d=[];f
'};function i(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=i(e,r.minimum,1),n.status=1===e?null:e;var s=n.render(!t),u=s.querySelector(r.barSelector),c=r.speed,f=r.easing;return s.offsetWidth,a((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(u,function(e,t,n){var i;return(i="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,i}(e,c,f)),1===e?(l(s,{transition:"none",opacity:1}),s.offsetWidth,setTimeout((function(){l(s,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*i(Math.random()*t,.1,.95)),t=i(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var i,a=t.querySelector(r.barSelector),s=e?"-100":o(n.status||0),c=document.querySelector(r.parent);return l(a,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(i=t.querySelector(r.spinnerSelector))&&d(i),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){c(document.documentElement,"nprogress-busy"),c(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&d(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var a=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()})),t[n]||(t[n]=function(t){var n=document.body.style;if(t in n)return t;for(var r,i=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);i--;)if((r=e[i]+o)in n)return r;return t}(n))}function r(e,t,r){t=n(t),e.style[t]=r}return function(e,t){var n,i,o=arguments;if(2==o.length)for(n in t)void 0!==(i=t[n])&&t.hasOwnProperty(n)&&r(e,n,i);else r(e,o[1],o[2])}}();function s(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=f(e),r=n+t;s(n,t)||(e.className=r.substring(1))}function c(e,t){var n,r=f(e);s(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function d(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n})?r.call(t,n,t,e):r)||(e.exports=i)},function(e,t,n){"use strict";var r=n(1),i=n(46).f,o=n(12),a=n(93),l=n(33),s=n(61),u=n(124);e.exports=function(e,t){var n,c,f,d,p,v=e.target,h=e.global,g=e.stat;if(n=h?r:g?r[v]||l(v,{}):(r[v]||{}).prototype)for(c in t){if(d=t[c],f=e.dontCallGetSet?(p=i(n,c))&&p.value:n[c],!u(h?c:v+(g?".":"#")+c,e.forced)&&void 0!==f){if(typeof d==typeof f)continue;s(d,f)}(e.sham||f&&f.sham)&&o(d,"sham",!0),a(n,c,d,e)}}},function(e,t,n){"use strict";var r=n(8),i=String,o=TypeError;e.exports=function(e){if(r(e))return e;throw o(i(e)+" is not an object")}},function(e,t,n){"use strict";var r=n(26),i=Function.prototype.call;e.exports=r?i.bind(i):function(){return i.apply(i,arguments)}},function(e,t,n){"use strict";var r=n(3);e.exports=!r((function(){var e=function(){}.bind();return"function"!=typeof e||e.hasOwnProperty("prototype")}))},function(e,t,n){"use strict";e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,n){"use strict";var r=n(47),i=n(48);e.exports=function(e){return r(i(e))}},function(e,t,n){"use strict";var r=n(1),i=n(0),o=function(e){return i(e)?e:void 0};e.exports=function(e,t){return arguments.length<2?o(r[e]):r[e]&&r[e][t]}},function(e,t,n){"use strict";var r=n(0),i=n(106),o=TypeError;e.exports=function(e){if(r(e))return e;throw o(i(e)+" is not a function")}},function(e,t,n){"use strict";var r=n(1),i=n(56),o=n(7),a=n(58),l=n(55),s=n(54),u=r.Symbol,c=i("wks"),f=s?u.for||u:u&&u.withoutSetter||a;e.exports=function(e){return o(c,e)||(c[e]=l&&o(u,e)?u[e]:f("Symbol."+e)),c[e]}},function(e,t,n){"use strict";var r=n(1),i=n(33),o=r["__core-js_shared__"]||i("__core-js_shared__",{});e.exports=o},function(e,t,n){"use strict";var r=n(1),i=Object.defineProperty;e.exports=function(e,t){try{i(r,e,{value:t,configurable:!0,writable:!0})}catch(n){r[e]=t}return t}},function(e,t,n){"use strict";var r=n(48),i=Object;e.exports=function(e){return i(r(e))}},function(e,t,n){"use strict";var r=n(121);e.exports=function(e){return r(e.length)}},function(e,t,n){var r=n(143),i=n(10),o=Object.prototype,a=o.hasOwnProperty,l=o.propertyIsEnumerable,s=r(function(){return arguments}())?r:function(e){return i(e)&&a.call(e,"callee")&&!l.call(e,"callee")};e.exports=s},function(e,t,n){var r=n(9)(n(6),"Map");e.exports=r},function(e,t){e.exports=function(e){var t=typeof e;return null!=e&&("object"==t||"function"==t)}},function(e,t,n){var r=n(163),i=n(170),o=n(172),a=n(173),l=n(174);function s(e){var t=-1,n=null==e?0:e.length;for(this.clear();++t-1&&e%1==0&&e<=9007199254740991}},function(e,t,n){var r=n(5),i=n(43),o=/\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/,a=/^\w*$/;e.exports=function(e,t){if(r(e))return!1;var n=typeof e;return!("number"!=n&&"symbol"!=n&&"boolean"!=n&&null!=e&&!i(e))||(a.test(e)||!o.test(e)||null!=t&&e in Object(t))}},function(e,t,n){var r=n(11),i=n(10);e.exports=function(e){return"symbol"==typeof e||i(e)&&"[object Symbol]"==r(e)}},function(e,t){e.exports=function(e){return e}},function(e,t,n){"use strict";var r,i,o=n(1),a=n(104),l=o.process,s=o.Deno,u=l&&l.versions||s&&s.version,c=u&&u.v8;c&&(i=(r=c.split("."))[0]>0&&r[0]<4?1:+(r[0]+r[1])),!i&&a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(i=+r[1]),e.exports=i},function(e,t,n){"use strict";var r=n(4),i=n(25),o=n(102),a=n(27),l=n(28),s=n(50),u=n(7),c=n(59),f=Object.getOwnPropertyDescriptor;t.f=r?f:function(e,t){if(e=l(e),t=s(t),c)try{return f(e,t)}catch(e){}if(u(e,t))return a(!i(o.f,e,t),e[t])}},function(e,t,n){"use strict";var r=n(2),i=n(3),o=n(16),a=Object,l=r("".split);e.exports=i((function(){return!a("z").propertyIsEnumerable(0)}))?function(e){return"String"===o(e)?l(e,""):a(e)}:a},function(e,t,n){"use strict";var r=n(49),i=TypeError;e.exports=function(e){if(r(e))throw i("Can't call method on "+e);return e}},function(e,t,n){"use strict";e.exports=function(e){return null==e}},function(e,t,n){"use strict";var r=n(103),i=n(52);e.exports=function(e){var t=r(e,"string");return i(t)?t:t+""}},function(e,t,n){"use strict";var r="object"==typeof document&&document.all,i=void 0===r&&void 0!==r;e.exports={all:r,IS_HTMLDDA:i}},function(e,t,n){"use strict";var r=n(29),i=n(0),o=n(53),a=n(54),l=Object;e.exports=a?function(e){return"symbol"==typeof e}:function(e){var t=r("Symbol");return i(t)&&o(t.prototype,l(e))}},function(e,t,n){"use strict";var r=n(2);e.exports=r({}.isPrototypeOf)},function(e,t,n){"use strict";var r=n(55);e.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol.iterator},function(e,t,n){"use strict";var r=n(45),i=n(3),o=n(1).String;e.exports=!!Object.getOwnPropertySymbols&&!i((function(){var e=Symbol("symbol detection");return!o(e)||!(Object(e)instanceof Symbol)||!Symbol.sham&&r&&r<41}))},function(e,t,n){"use strict";var r=n(57),i=n(32);(e.exports=function(e,t){return i[e]||(i[e]=void 0!==t?t:{})})("versions",[]).push({version:"3.32.2",mode:r?"pure":"global",copyright:"© 2014-2023 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.32.2/LICENSE",source:"https://github.com/zloirock/core-js"})},function(e,t,n){"use strict";e.exports=!1},function(e,t,n){"use strict";var r=n(2),i=0,o=Math.random(),a=r(1..toString);e.exports=function(e){return"Symbol("+(void 0===e?"":e)+")_"+a(++i+o,36)}},function(e,t,n){"use strict";var r=n(4),i=n(3),o=n(108);e.exports=!r&&!i((function(){return 7!==Object.defineProperty(o("div"),"a",{get:function(){return 7}}).a}))},function(e,t,n){"use strict";e.exports={}},function(e,t,n){"use strict";var r=n(7),i=n(115),o=n(46),a=n(15);e.exports=function(e,t,n){for(var l=i(t),s=a.f,u=o.f,c=0;cc))return!1;var d=s.get(e),p=s.get(t);if(d&&p)return d==t&&p==e;var v=-1,h=!0,g=2&n?new r:void 0;for(s.set(e,t),s.set(t,e);++v-1&&e%1==0&&e=0&&Math.floor(t)===t&&isFinite(e)}function h(e){return a(e)&&"function"==typeof e.then&&"function"==typeof e.catch}function g(e){return null==e?"":Array.isArray(e)||d(e)&&e.toString===f?JSON.stringify(e,null,2):String(e)}function m(e){var t=parseFloat(e);return isNaN(t)?e:t}function y(e,t){for(var n=Object.create(null),r=e.split(","),i=0;i-1)return e.splice(r,1)}}var x=Object.prototype.hasOwnProperty;function w(e,t){return x.call(e,t)}function C(e){var t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}var S=/-(\w)/g,k=C((function(e){return e.replace(S,(function(e,t){return t?t.toUpperCase():""}))})),P=C((function(e){return e.charAt(0).toUpperCase()+e.slice(1)})),O=/\B([A-Z])/g,E=C((function(e){return e.replace(O,"-$1").toLowerCase()}));var $=Function.prototype.bind?function(e,t){return e.bind(t)}:function(e,t){function n(n){var r=arguments.length;return r?r>1?e.apply(t,arguments):e.call(t,n):e.call(t)}return n._length=e.length,n};function j(e,t){t=t||0;for(var n=e.length-t,r=new Array(n);n--;)r[n]=e[n+t];return r}function A(e,t){for(var n in t)e[n]=t[n];return e}function T(e){for(var t={},n=0;n0,J=Y&&Y.indexOf("edge/")>0;Y&&Y.indexOf("android");var Q=Y&&/iphone|ipad|ipod|ios/.test(Y);Y&&/chrome\/\d+/.test(Y),Y&&/phantomjs/.test(Y);var ee,te=Y&&Y.match(/firefox\/(\d+)/),ne={}.watch,re=!1;if(K)try{var ie={};Object.defineProperty(ie,"passive",{get:function(){re=!0}}),window.addEventListener("test-passive",null,ie)}catch(e){}var oe=function(){return void 0===ee&&(ee=!K&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),ee},ae=K&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function le(e){return"function"==typeof e&&/native code/.test(e.toString())}var se,ue="undefined"!=typeof Symbol&&le(Symbol)&&"undefined"!=typeof Reflect&&le(Reflect.ownKeys);se="undefined"!=typeof Set&&le(Set)?Set:function(){function e(){this.set=Object.create(null)}return e.prototype.has=function(e){return!0===this.set[e]},e.prototype.add=function(e){this.set[e]=!0},e.prototype.clear=function(){this.set=Object.create(null)},e}();var ce=null;function fe(e){void 0===e&&(e=null),e||ce&&ce._scope.off(),ce=e,e&&e._scope.on()}var de=function(){function e(e,t,n,r,i,o,a,l){this.tag=e,this.data=t,this.children=n,this.text=r,this.elm=i,this.ns=void 0,this.context=o,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=t&&t.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=l,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(e.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),e}(),pe=function(e){void 0===e&&(e="");var t=new de;return t.text=e,t.isComment=!0,t};function ve(e){return new de(void 0,void 0,void 0,String(e))}function he(e){var t=new de(e.tag,e.data,e.children&&e.children.slice(),e.text,e.elm,e.context,e.componentOptions,e.asyncFactory);return t.ns=e.ns,t.isStatic=e.isStatic,t.key=e.key,t.isComment=e.isComment,t.fnContext=e.fnContext,t.fnOptions=e.fnOptions,t.fnScopeId=e.fnScopeId,t.asyncMeta=e.asyncMeta,t.isCloned=!0,t}var ge=0,me=[],ye=function(){function e(){this._pending=!1,this.id=ge++,this.subs=[]}return e.prototype.addSub=function(e){this.subs.push(e)},e.prototype.removeSub=function(e){this.subs[this.subs.indexOf(e)]=null,this._pending||(this._pending=!0,me.push(this))},e.prototype.depend=function(t){e.target&&e.target.addDep(this)},e.prototype.notify=function(e){var t=this.subs.filter((function(e){return e}));for(var n=0,r=t.length;n0&&(Ye((u=e(u,"".concat(n||"","_").concat(r)))[0])&&Ye(f)&&(d[c]=ve(f.text+u[0].text),u.shift()),d.push.apply(d,u)):s(u)?Ye(f)?d[c]=ve(f.text+u):""!==u&&d.push(ve(u)):Ye(u)&&Ye(f)?d[c]=ve(f.text+u.text):(l(t._isVList)&&a(u.tag)&&o(u.key)&&a(n)&&(u.key="__vlist".concat(n,"_").concat(r,"__")),d.push(u)));return d}(e):void 0}function Ye(e){return a(e)&&a(e.text)&&!1===e.isComment}function Xe(e,t){var n,r,o,l,s=null;if(i(e)||"string"==typeof e)for(s=new Array(e.length),n=0,r=e.length;n0,l=t?!!t.$stable:!a,s=t&&t.$key;if(t){if(t._normalized)return t._normalized;if(l&&i&&i!==r&&s===i.$key&&!a&&!i.$hasNormal)return i;for(var u in o={},t)t[u]&&"$"!==u[0]&&(o[u]=ht(e,n,u,t[u]))}else o={};for(var c in n)c in o||(o[c]=gt(n,c));return t&&Object.isExtensible(t)&&(t._normalized=o),W(o,"$stable",l),W(o,"$key",s),W(o,"$hasNormal",a),o}function ht(e,t,n,r){var o=function(){var t=ce;fe(e);var n=arguments.length?r.apply(null,arguments):r({}),o=(n=n&&"object"==typeof n&&!i(n)?[n]:Ke(n))&&n[0];return fe(t),n&&(!o||1===n.length&&o.isComment&&!pt(o))?void 0:n};return r.proxy&&Object.defineProperty(t,n,{get:o,enumerable:!0,configurable:!0}),o}function gt(e,t){return function(){return e[t]}}function mt(e){return{get attrs(){if(!e._attrsProxy){var t=e._attrsProxy={};W(t,"_v_attr_proxy",!0),yt(t,e.$attrs,r,e,"$attrs")}return e._attrsProxy},get listeners(){e._listenersProxy||yt(e._listenersProxy={},e.$listeners,r,e,"$listeners");return e._listenersProxy},get slots(){return function(e){e._slotsProxy||_t(e._slotsProxy={},e.$scopedSlots);return e._slotsProxy}(e)},emit:$(e.$emit,e),expose:function(t){t&&Object.keys(t).forEach((function(n){return Ne(e,t,n)}))}}}function yt(e,t,n,r,i){var o=!1;for(var a in t)a in e?t[a]!==n[a]&&(o=!0):(o=!0,bt(e,a,r,i));for(var a in e)a in t||(o=!0,delete e[a]);return o}function bt(e,t,n,r){Object.defineProperty(e,t,{enumerable:!0,configurable:!0,get:function(){return n[r][t]}})}function _t(e,t){for(var n in t)e[n]=t[n];for(var n in e)n in t||delete e[n]}var xt=null;function wt(e,t){return(e.__esModule||ue&&"Module"===e[Symbol.toStringTag])&&(e=e.default),c(e)?t.extend(e):e}function Ct(e){if(i(e))for(var t=0;tdocument.createEvent("Event").timeStamp&&(sn=function(){return un.now()})}var cn=function(e,t){if(e.post){if(!t.post)return 1}else if(t.post)return-1;return e.id-t.id};function fn(){var e,t;for(ln=sn(),on=!0,en.sort(cn),an=0;anan&&en[n].id>e.id;)n--;en.splice(n+1,0,e)}else en.push(e);rn||(rn=!0,Mt(fn))}}function pn(e,t){if(e){for(var n=Object.create(null),r=ue?Reflect.ownKeys(e):Object.keys(e),i=0;i-1)if(o&&!w(i,"default"))a=!1;else if(""===a||a===E(e)){var s=Rn(String,i.type);(s<0||l-1:"string"==typeof e?e.split(",").indexOf(t)>-1:!!p(e)&&e.test(t)}function Xn(e,t){var n=e.cache,r=e.keys,i=e._vnode;for(var o in n){var a=n[o];if(a){var l=a.name;l&&!t(l)&&Zn(n,o,r,i)}}}function Zn(e,t,n,r){var i=e[t];!i||r&&i.tag===r.tag||i.componentInstance.$destroy(),e[t]=null,_(n,t)}qn.prototype._init=function(e){var t=this;t._uid=Hn++,t._isVue=!0,t.__v_skip=!0,t._scope=new Ue(!0),t._scope._vm=!0,e&&e._isComponent?function(e,t){var n=e.$options=Object.create(e.constructor.options),r=t._parentVnode;n.parent=t.parent,n._parentVnode=r;var i=r.componentOptions;n.propsData=i.propsData,n._parentListeners=i.listeners,n._renderChildren=i.children,n._componentTag=i.tag,t.render&&(n.render=t.render,n.staticRenderFns=t.staticRenderFns)}(t,e):t.$options=$n(Wn(t.constructor),e||{},t),t._renderProxy=t,t._self=t,function(e){var t=e.$options,n=t.parent;if(n&&!t.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(e)}e.$parent=n,e.$root=n?n.$root:e,e.$children=[],e.$refs={},e._provided=n?n._provided:Object.create(null),e._watcher=null,e._inactive=null,e._directInactive=!1,e._isMounted=!1,e._isDestroyed=!1,e._isBeingDestroyed=!1}(t),function(e){e._events=Object.create(null),e._hasHookEvent=!1;var t=e.$options._parentListeners;t&&Kt(e,t)}(t),function(e){e._vnode=null,e._staticTrees=null;var t=e.$options,n=e.$vnode=t._parentVnode,i=n&&n.context;e.$slots=ft(t._renderChildren,i),e.$scopedSlots=n?vt(e.$parent,n.data.scopedSlots,e.$slots):r,e._c=function(t,n,r,i){return St(e,t,n,r,i,!1)},e.$createElement=function(t,n,r,i){return St(e,t,n,r,i,!0)};var o=n&&n.data;Ae(e,"$attrs",o&&o.attrs||r,null,!0),Ae(e,"$listeners",t._parentListeners||r,null,!0)}(t),Qt(t,"beforeCreate",void 0,!1),function(e){var t=pn(e.$options.inject,e);t&&(Oe(!1),Object.keys(t).forEach((function(n){Ae(e,n,t[n])})),Oe(!0))}(t),Mn(t),function(e){var t=e.$options.provide;if(t){var n=u(t)?t.call(e):t;if(!c(n))return;for(var r=Be(e),i=ue?Reflect.ownKeys(n):Object.keys(n),o=0;o1?j(n):n;for(var r=j(arguments,1),i='event handler for "'.concat(e,'"'),o=0,a=n.length;oparseInt(this.max)&&Zn(e,t[0],t,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var e in this.cache)Zn(this.cache,e,this.keys)},mounted:function(){var e=this;this.cacheVNode(),this.$watch("include",(function(t){Xn(e,(function(e){return Yn(t,e)}))})),this.$watch("exclude",(function(t){Xn(e,(function(e){return!Yn(t,e)}))}))},updated:function(){this.cacheVNode()},render:function(){var e=this.$slots.default,t=Ct(e),n=t&&t.componentOptions;if(n){var r=Kn(n),i=this.include,o=this.exclude;if(i&&(!r||!Yn(i,r))||o&&r&&Yn(o,r))return t;var a=this.cache,l=this.keys,s=null==t.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):t.key;a[s]?(t.componentInstance=a[s].componentInstance,_(l,s),l.push(s)):(this.vnodeToCache=t,this.keyToCache=s),t.data.keepAlive=!0}return t||e&&e[0]}}};!function(e){var t={get:function(){return B}};Object.defineProperty(e,"config",t),e.util={warn:wn,extend:A,mergeOptions:$n,defineReactive:Ae},e.set=Te,e.delete=De,e.nextTick=Mt,e.observable=function(e){return je(e),e},e.options=Object.create(null),z.forEach((function(t){e.options[t+"s"]=Object.create(null)})),e.options._base=e,A(e.options.components,Qn),function(e){e.use=function(e){var t=this._installedPlugins||(this._installedPlugins=[]);if(t.indexOf(e)>-1)return this;var n=j(arguments,1);return n.unshift(this),u(e.install)?e.install.apply(e,n):u(e)&&e.apply(null,n),t.push(e),this}}(e),function(e){e.mixin=function(e){return this.options=$n(this.options,e),this}}(e),Gn(e),function(e){z.forEach((function(t){e[t]=function(e,n){return n?("component"===t&&d(n)&&(n.name=n.name||e,n=this.options._base.extend(n)),"directive"===t&&u(n)&&(n={bind:n,update:n}),this.options[t+"s"][e]=n,n):this.options[t+"s"][e]}}))}(e)}(qn),Object.defineProperty(qn.prototype,"$isServer",{get:oe}),Object.defineProperty(qn.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(qn,"FunctionalRenderContext",{value:vn}),qn.version="2.7.14";var er=y("style,class"),tr=y("input,textarea,option,select,progress"),nr=y("contenteditable,draggable,spellcheck"),rr=y("events,caret,typing,plaintext-only"),ir=y("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),or="http://www.w3.org/1999/xlink",ar=function(e){return":"===e.charAt(5)&&"xlink"===e.slice(0,5)},lr=function(e){return ar(e)?e.slice(6,e.length):""},sr=function(e){return null==e||!1===e};function ur(e){for(var t=e.data,n=e,r=e;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(t=cr(r.data,t));for(;a(n=n.parent);)n&&n.data&&(t=cr(t,n.data));return function(e,t){if(a(e)||a(t))return fr(e,dr(t));return""}(t.staticClass,t.class)}function cr(e,t){return{staticClass:fr(e.staticClass,t.staticClass),class:a(e.class)?[e.class,t.class]:t.class}}function fr(e,t){return e?t?e+" "+t:e:t||""}function dr(e){return Array.isArray(e)?function(e){for(var t,n="",r=0,i=e.length;r-1?Ir(e,t,n):ir(t)?sr(n)?e.removeAttribute(t):(n="allowfullscreen"===t&&"EMBED"===e.tagName?"true":t,e.setAttribute(t,n)):nr(t)?e.setAttribute(t,function(e,t){return sr(t)||"false"===t?"false":"contenteditable"===e&&rr(t)?t:"true"}(t,n)):ar(t)?sr(n)?e.removeAttributeNS(or,lr(t)):e.setAttributeNS(or,t,n):Ir(e,t,n)}function Ir(e,t,n){if(sr(n))e.removeAttribute(t);else{if(X&&!Z&&"TEXTAREA"===e.tagName&&"placeholder"===t&&""!==n&&!e.__ieph){var r=function(t){t.stopImmediatePropagation(),e.removeEventListener("input",r)};e.addEventListener("input",r),e.__ieph=!0}e.setAttribute(t,n)}}var Fr={create:Lr,update:Lr};function Mr(e,t){var n=t.elm,r=t.data,i=e.data;if(!(o(r.staticClass)&&o(r.class)&&(o(i)||o(i.staticClass)&&o(i.class)))){var l=ur(t),s=n._transitionClasses;a(s)&&(l=fr(l,dr(s))),l!==n._prevClass&&(n.setAttribute("class",l),n._prevClass=l)}}var Nr,zr={create:Mr,update:Mr};function Ur(e,t,n){var r=Nr;return function i(){var o=t.apply(null,arguments);null!==o&&Hr(e,i,n,r)}}var Br=jt&&!(te&&Number(te[1])<=53);function Vr(e,t,n,r){if(Br){var i=ln,o=t;t=o._wrapper=function(e){if(e.target===e.currentTarget||e.timeStamp>=i||e.timeStamp<=0||e.target.ownerDocument!==document)return o.apply(this,arguments)}}Nr.addEventListener(e,t,re?{capture:n,passive:r}:n)}function Hr(e,t,n,r){(r||Nr).removeEventListener(e,t._wrapper||t,n)}function Wr(e,t){if(!o(e.data.on)||!o(t.data.on)){var n=t.data.on||{},r=e.data.on||{};Nr=t.elm||e.elm,function(e){if(a(e.__r)){var t=X?"change":"input";e[t]=[].concat(e.__r,e[t]||[]),delete e.__r}a(e.__c)&&(e.change=[].concat(e.__c,e.change||[]),delete e.__c)}(n),We(n,r,Vr,Hr,Ur,t.context),Nr=void 0}}var qr,Gr={create:Wr,update:Wr,destroy:function(e){return Wr(e,Cr)}};function Kr(e,t){if(!o(e.data.domProps)||!o(t.data.domProps)){var n,r,i=t.elm,s=e.data.domProps||{},u=t.data.domProps||{};for(n in(a(u.__ob__)||l(u._v_attr_proxy))&&(u=t.data.domProps=A({},u)),s)n in u||(i[n]="");for(n in u){if(r=u[n],"textContent"===n||"innerHTML"===n){if(t.children&&(t.children.length=0),r===s[n])continue;1===i.childNodes.length&&i.removeChild(i.childNodes[0])}if("value"===n&&"PROGRESS"!==i.tagName){i._value=r;var c=o(r)?"":String(r);Yr(i,c)&&(i.value=c)}else if("innerHTML"===n&&hr(i.tagName)&&o(i.innerHTML)){(qr=qr||document.createElement("div")).innerHTML="".concat(r,"");for(var f=qr.firstChild;i.firstChild;)i.removeChild(i.firstChild);for(;f.firstChild;)i.appendChild(f.firstChild)}else if(r!==s[n])try{i[n]=r}catch(e){}}}}function Yr(e,t){return!e.composing&&("OPTION"===e.tagName||function(e,t){var n=!0;try{n=document.activeElement!==e}catch(e){}return n&&e.value!==t}(e,t)||function(e,t){var n=e.value,r=e._vModifiers;if(a(r)){if(r.number)return m(n)!==m(t);if(r.trim)return n.trim()!==t.trim()}return n!==t}(e,t))}var Xr={create:Kr,update:Kr},Zr=C((function(e){var t={},n=/:(.+)/;return e.split(/;(?![^(]*\))/g).forEach((function(e){if(e){var r=e.split(n);r.length>1&&(t[r[0].trim()]=r[1].trim())}})),t}));function Jr(e){var t=Qr(e.style);return e.staticStyle?A(e.staticStyle,t):t}function Qr(e){return Array.isArray(e)?T(e):"string"==typeof e?Zr(e):e}var ei,ti=/^--/,ni=/\s*!important$/,ri=function(e,t,n){if(ti.test(t))e.style.setProperty(t,n);else if(ni.test(n))e.style.setProperty(E(t),n.replace(ni,""),"important");else{var r=oi(t);if(Array.isArray(n))for(var i=0,o=n.length;i-1?t.split(si).forEach((function(t){return e.classList.add(t)})):e.classList.add(t);else{var n=" ".concat(e.getAttribute("class")||""," ");n.indexOf(" "+t+" ")<0&&e.setAttribute("class",(n+t).trim())}}function ci(e,t){if(t&&(t=t.trim()))if(e.classList)t.indexOf(" ")>-1?t.split(si).forEach((function(t){return e.classList.remove(t)})):e.classList.remove(t),e.classList.length||e.removeAttribute("class");else{for(var n=" ".concat(e.getAttribute("class")||""," "),r=" "+t+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?e.setAttribute("class",n):e.removeAttribute("class")}}function fi(e){if(e){if("object"==typeof e){var t={};return!1!==e.css&&A(t,di(e.name||"v")),A(t,e),t}return"string"==typeof e?di(e):void 0}}var di=C((function(e){return{enterClass:"".concat(e,"-enter"),enterToClass:"".concat(e,"-enter-to"),enterActiveClass:"".concat(e,"-enter-active"),leaveClass:"".concat(e,"-leave"),leaveToClass:"".concat(e,"-leave-to"),leaveActiveClass:"".concat(e,"-leave-active")}})),pi=K&&!Z,vi="transition",hi="transitionend",gi="animation",mi="animationend";pi&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(vi="WebkitTransition",hi="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(gi="WebkitAnimation",mi="webkitAnimationEnd"));var yi=K?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(e){return e()};function bi(e){yi((function(){yi(e)}))}function _i(e,t){var n=e._transitionClasses||(e._transitionClasses=[]);n.indexOf(t)<0&&(n.push(t),ui(e,t))}function xi(e,t){e._transitionClasses&&_(e._transitionClasses,t),ci(e,t)}function wi(e,t,n){var r=Si(e,t),i=r.type,o=r.timeout,a=r.propCount;if(!i)return n();var l="transition"===i?hi:mi,s=0,u=function(){e.removeEventListener(l,c),n()},c=function(t){t.target===e&&++s>=a&&u()};setTimeout((function(){s0&&(n="transition",c=a,f=o.length):"animation"===t?u>0&&(n="animation",c=u,f=s.length):f=(n=(c=Math.max(a,u))>0?a>u?"transition":"animation":null)?"transition"===n?o.length:s.length:0,{type:n,timeout:c,propCount:f,hasTransform:"transition"===n&&Ci.test(r[vi+"Property"])}}function ki(e,t){for(;e.length1}function Ai(e,t){!0!==t.data.show&&Oi(t)}var Ti=function(e){var t,n,r={},u=e.modules,c=e.nodeOps;for(t=0;tv?_(e,o(n[m+1])?null:n[m+1].elm,n,p,m,r):p>m&&w(t,f,v)}(f,h,m,n,u):a(m)?(a(e.text)&&c.setTextContent(f,""),_(f,null,m,0,m.length-1,n)):a(h)?w(h,0,h.length-1):a(e.text)&&c.setTextContent(f,""):e.text!==t.text&&c.setTextContent(f,t.text),a(v)&&a(p=v.hook)&&a(p=p.postpatch)&&p(e,t)}}}function P(e,t,n){if(l(n)&&a(e.parent))e.parent.data.pendingInsert=t;else for(var r=0;r-1,a.selected!==o&&(a.selected=o);else if(I(Fi(a),r))return void(e.selectedIndex!==l&&(e.selectedIndex=l));i||(e.selectedIndex=-1)}}function Ii(e,t){return t.every((function(t){return!I(t,e)}))}function Fi(e){return"_value"in e?e._value:e.value}function Mi(e){e.target.composing=!0}function Ni(e){e.target.composing&&(e.target.composing=!1,zi(e.target,"input"))}function zi(e,t){var n=document.createEvent("HTMLEvents");n.initEvent(t,!0,!0),e.dispatchEvent(n)}function Ui(e){return!e.componentInstance||e.data&&e.data.transition?e:Ui(e.componentInstance._vnode)}var Bi={model:Di,show:{bind:function(e,t,n){var r=t.value,i=(n=Ui(n)).data&&n.data.transition,o=e.__vOriginalDisplay="none"===e.style.display?"":e.style.display;r&&i?(n.data.show=!0,Oi(n,(function(){e.style.display=o}))):e.style.display=r?o:"none"},update:function(e,t,n){var r=t.value;!r!=!t.oldValue&&((n=Ui(n)).data&&n.data.transition?(n.data.show=!0,r?Oi(n,(function(){e.style.display=e.__vOriginalDisplay})):Ei(n,(function(){e.style.display="none"}))):e.style.display=r?e.__vOriginalDisplay:"none")},unbind:function(e,t,n,r,i){i||(e.style.display=e.__vOriginalDisplay)}}},Vi={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Hi(e){var t=e&&e.componentOptions;return t&&t.Ctor.options.abstract?Hi(Ct(t.children)):e}function Wi(e){var t={},n=e.$options;for(var r in n.propsData)t[r]=e[r];var i=n._parentListeners;for(var r in i)t[k(r)]=i[r];return t}function qi(e,t){if(/\d-keep-alive$/.test(t.tag))return e("keep-alive",{props:t.componentOptions.propsData})}var Gi=function(e){return e.tag||pt(e)},Ki=function(e){return"show"===e.name},Yi={name:"transition",props:Vi,abstract:!0,render:function(e){var t=this,n=this.$slots.default;if(n&&(n=n.filter(Gi)).length){0;var r=this.mode;0;var i=n[0];if(function(e){for(;e=e.parent;)if(e.data.transition)return!0}(this.$vnode))return i;var o=Hi(i);if(!o)return i;if(this._leaving)return qi(e,i);var a="__transition-".concat(this._uid,"-");o.key=null==o.key?o.isComment?a+"comment":a+o.tag:s(o.key)?0===String(o.key).indexOf(a)?o.key:a+o.key:o.key;var l=(o.data||(o.data={})).transition=Wi(this),u=this._vnode,c=Hi(u);if(o.data.directives&&o.data.directives.some(Ki)&&(o.data.show=!0),c&&c.data&&!function(e,t){return t.key===e.key&&t.tag===e.tag}(o,c)&&!pt(c)&&(!c.componentInstance||!c.componentInstance._vnode.isComment)){var f=c.data.transition=A({},l);if("out-in"===r)return this._leaving=!0,qe(f,"afterLeave",(function(){t._leaving=!1,t.$forceUpdate()})),qi(e,i);if("in-out"===r){if(pt(o))return u;var d,p=function(){d()};qe(l,"afterEnter",p),qe(l,"enterCancelled",p),qe(f,"delayLeave",(function(e){d=e}))}}return i}}},Xi=A({tag:String,moveClass:String},Vi);function Zi(e){e.elm._moveCb&&e.elm._moveCb(),e.elm._enterCb&&e.elm._enterCb()}function Ji(e){e.data.newPos=e.elm.getBoundingClientRect()}function Qi(e){var t=e.data.pos,n=e.data.newPos,r=t.left-n.left,i=t.top-n.top;if(r||i){e.data.moved=!0;var o=e.elm.style;o.transform=o.WebkitTransform="translate(".concat(r,"px,").concat(i,"px)"),o.transitionDuration="0s"}}delete Xi.mode;var eo={Transition:Yi,TransitionGroup:{props:Xi,beforeMount:function(){var e=this,t=this._update;this._update=function(n,r){var i=Xt(e);e.__patch__(e._vnode,e.kept,!1,!0),e._vnode=e.kept,i(),t.call(e,n,r)}},render:function(e){for(var t=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,i=this.$slots.default||[],o=this.children=[],a=Wi(this),l=0;l-1?mr[e]=t.constructor===window.HTMLUnknownElement||t.constructor===window.HTMLElement:mr[e]=/HTMLUnknownElement/.test(t.toString())},A(qn.options.directives,Bi),A(qn.options.components,eo),qn.prototype.__patch__=K?Ti:D,qn.prototype.$mount=function(e,t){return function(e,t,n){var r;e.$el=t,e.$options.render||(e.$options.render=pe),Qt(e,"beforeMount"),r=function(){e._update(e._render(),n)},new Ht(e,r,D,{before:function(){e._isMounted&&!e._isDestroyed&&Qt(e,"beforeUpdate")}},!0),n=!1;var i=e._preWatchers;if(i)for(var o=0;o=0&&(t=e.slice(r),e=e.slice(0,r));var i=e.indexOf("?");return i>=0&&(n=e.slice(i+1),e=e.slice(0,i)),{path:e,query:n,hash:t}}(i.path||""),u=t&&t.path||"/",c=s.path?wo(s.path,u,n||i.append):u,f=function(e,t,n){void 0===t&&(t={});var r,i=n||so;try{r=i(e||"")}catch(e){r={}}for(var o in t){var a=t[o];r[o]=Array.isArray(a)?a.map(lo):lo(a)}return r}(s.query,i.query,r&&r.options.parseQuery),d=i.hash||s.hash;return d&&"#"!==d.charAt(0)&&(d="#"+d),{_normalized:!0,path:c,query:f,hash:d}}var Vo,Ho=function(){},Wo={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(e){var t=this,n=this.$router,r=this.$route,i=n.resolve(this.to,r,this.append),o=i.location,a=i.route,l=i.href,s={},u=n.options.linkActiveClass,c=n.options.linkExactActiveClass,f=null==u?"router-link-active":u,d=null==c?"router-link-exact-active":c,p=null==this.activeClass?f:this.activeClass,v=null==this.exactActiveClass?d:this.exactActiveClass,h=a.redirectedFrom?fo(null,Bo(a.redirectedFrom),null,n):a;s[v]=mo(r,h,this.exactPath),s[p]=this.exact||this.exactPath?s[v]:function(e,t){return 0===e.path.replace(co,"/").indexOf(t.path.replace(co,"/"))&&(!t.hash||e.hash===t.hash)&&function(e,t){for(var n in t)if(!(n in e))return!1;return!0}(e.query,t.query)}(r,h);var g=s[v]?this.ariaCurrentValue:null,m=function(e){qo(e)&&(t.replace?n.replace(o,Ho):n.push(o,Ho))},y={click:qo};Array.isArray(this.event)?this.event.forEach((function(e){y[e]=m})):y[this.event]=m;var b={class:s},_=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:a,navigate:m,isActive:s[p],isExactActive:s[v]});if(_){if(1===_.length)return _[0];if(_.length>1||!_.length)return 0===_.length?e():e("span",{},_)}if("a"===this.tag)b.on=y,b.attrs={href:l,"aria-current":g};else{var x=function e(t){var n;if(t)for(var r=0;r-1&&(l.params[d]=n.params[d]);return l.path=Uo(c.path,l.params),s(c,l,a)}if(l.path){l.params={};for(var p=0;p-1}function Ca(e,t){return wa(e)&&e._isRouter&&(null==t||e.type===t)}function Sa(e,t,n){var r=function(i){i>=e.length?n():e[i]?t(e[i],(function(){r(i+1)})):r(i+1)};r(0)}function ka(e){return function(t,n,r){var i=!1,o=0,a=null;Pa(e,(function(e,t,n,l){if("function"==typeof e&&void 0===e.cid){i=!0,o++;var s,u=$a((function(t){var i;((i=t).__esModule||Ea&&"Module"===i[Symbol.toStringTag])&&(t=t.default),e.resolved="function"==typeof t?t:Vo.extend(t),n.components[l]=t,--o<=0&&r()})),c=$a((function(e){var t="Failed to resolve async component "+l+": "+e;a||(a=wa(e)?e:new Error(t),r(a))}));try{s=e(u,c)}catch(e){c(e)}if(s)if("function"==typeof s.then)s.then(u,c);else{var f=s.component;f&&"function"==typeof f.then&&f.then(u,c)}}})),i||r()}}function Pa(e,t){return Oa(e.map((function(e){return Object.keys(e.components).map((function(n){return t(e.components[n],e.instances[n],e,n)}))})))}function Oa(e){return Array.prototype.concat.apply([],e)}var Ea="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function $a(e){var t=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!t)return t=!0,e.apply(this,n)}}var ja=function(e,t){this.router=e,this.base=function(e){if(!e)if(Go){var t=document.querySelector("base");e=(e=t&&t.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else e="/";"/"!==e.charAt(0)&&(e="/"+e);return e.replace(/\/$/,"")}(t),this.current=vo,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Aa(e,t,n,r){var i=Pa(e,(function(e,r,i,o){var a=function(e,t){"function"!=typeof e&&(e=Vo.extend(e));return e.options[t]}(e,t);if(a)return Array.isArray(a)?a.map((function(e){return n(e,r,i,o)})):n(a,r,i,o)}));return Oa(r?i.reverse():i)}function Ta(e,t){if(t)return function(){return e.apply(t,arguments)}}ja.prototype.listen=function(e){this.cb=e},ja.prototype.onReady=function(e,t){this.ready?e():(this.readyCbs.push(e),t&&this.readyErrorCbs.push(t))},ja.prototype.onError=function(e){this.errorCbs.push(e)},ja.prototype.transitionTo=function(e,t,n){var r,i=this;try{r=this.router.match(e,this.current)}catch(e){throw this.errorCbs.forEach((function(t){t(e)})),e}var o=this.current;this.confirmTransition(r,(function(){i.updateRoute(r),t&&t(r),i.ensureURL(),i.router.afterHooks.forEach((function(e){e&&e(r,o)})),i.ready||(i.ready=!0,i.readyCbs.forEach((function(e){e(r)})))}),(function(e){n&&n(e),e&&!i.ready&&(Ca(e,ma.redirected)&&o===vo||(i.ready=!0,i.readyErrorCbs.forEach((function(t){t(e)}))))}))},ja.prototype.confirmTransition=function(e,t,n){var r=this,i=this.current;this.pending=e;var o,a,l=function(e){!Ca(e)&&wa(e)&&(r.errorCbs.length?r.errorCbs.forEach((function(t){t(e)})):console.error(e)),n&&n(e)},s=e.matched.length-1,u=i.matched.length-1;if(mo(e,i)&&s===u&&e.matched[s]===i.matched[u])return this.ensureURL(),e.hash&&oa(this.router,i,e,!1),l(((a=_a(o=i,e,ma.duplicated,'Avoided redundant navigation to current location: "'+o.fullPath+'".')).name="NavigationDuplicated",a));var c=function(e,t){var n,r=Math.max(e.length,t.length);for(n=0;n0)){var t=this.router,n=t.options.scrollBehavior,r=va&&n;r&&this.listeners.push(ia());var i=function(){var n=e.current,i=La(e.base);e.current===vo&&i===e._startLocation||e.transitionTo(i,(function(e){r&&oa(t,e,n,!0)}))};window.addEventListener("popstate",i),this.listeners.push((function(){window.removeEventListener("popstate",i)}))}},t.prototype.go=function(e){window.history.go(e)},t.prototype.push=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){ha(Co(r.base+e.fullPath)),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){ga(Co(r.base+e.fullPath)),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.ensureURL=function(e){if(La(this.base)!==this.current.fullPath){var t=Co(this.base+this.current.fullPath);e?ha(t):ga(t)}},t.prototype.getCurrentLocation=function(){return La(this.base)},t}(ja);function La(e){var t=window.location.pathname,n=t.toLowerCase(),r=e.toLowerCase();return!e||n!==r&&0!==n.indexOf(Co(r+"/"))||(t=t.slice(e.length)),(t||"/")+window.location.search+window.location.hash}var Ra=function(e){function t(t,n,r){e.call(this,t,n),r&&function(e){var t=La(e);if(!/^\/#/.test(t))return window.location.replace(Co(e+"/#"+t)),!0}(this.base)||Ia()}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.setupListeners=function(){var e=this;if(!(this.listeners.length>0)){var t=this.router.options.scrollBehavior,n=va&&t;n&&this.listeners.push(ia());var r=function(){var t=e.current;Ia()&&e.transitionTo(Fa(),(function(r){n&&oa(e.router,r,t,!0),va||za(r.fullPath)}))},i=va?"popstate":"hashchange";window.addEventListener(i,r),this.listeners.push((function(){window.removeEventListener(i,r)}))}},t.prototype.push=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){Na(e.fullPath),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){za(e.fullPath),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.go=function(e){window.history.go(e)},t.prototype.ensureURL=function(e){var t=this.current.fullPath;Fa()!==t&&(e?Na(t):za(t))},t.prototype.getCurrentLocation=function(){return Fa()},t}(ja);function Ia(){var e=Fa();return"/"===e.charAt(0)||(za("/"+e),!1)}function Fa(){var e=window.location.href,t=e.indexOf("#");return t<0?"":e=e.slice(t+1)}function Ma(e){var t=window.location.href,n=t.indexOf("#");return(n>=0?t.slice(0,n):t)+"#"+e}function Na(e){va?ha(Ma(e)):window.location.hash=e}function za(e){va?ga(Ma(e)):window.location.replace(Ma(e))}var Ua=function(e){function t(t,n){e.call(this,t,n),this.stack=[],this.index=-1}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.push=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index+1).concat(e),r.index++,t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index).concat(e),t&&t(e)}),n)},t.prototype.go=function(e){var t=this,n=this.index+e;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var e=t.current;t.index=n,t.updateRoute(r),t.router.afterHooks.forEach((function(t){t&&t(r,e)}))}),(function(e){Ca(e,ma.duplicated)&&(t.index=n)}))}},t.prototype.getCurrentLocation=function(){var e=this.stack[this.stack.length-1];return e?e.fullPath:"/"},t.prototype.ensureURL=function(){},t}(ja),Ba=function(e){void 0===e&&(e={}),this.app=null,this.apps=[],this.options=e,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Xo(e.routes||[],this);var t=e.mode||"hash";switch(this.fallback="history"===t&&!va&&!1!==e.fallback,this.fallback&&(t="hash"),Go||(t="abstract"),this.mode=t,t){case"history":this.history=new Da(this,e.base);break;case"hash":this.history=new Ra(this,e.base,this.fallback);break;case"abstract":this.history=new Ua(this,e.base);break;default:0}},Va={currentRoute:{configurable:!0}};Ba.prototype.match=function(e,t,n){return this.matcher.match(e,t,n)},Va.currentRoute.get=function(){return this.history&&this.history.current},Ba.prototype.init=function(e){var t=this;if(this.apps.push(e),e.$once("hook:destroyed",(function(){var n=t.apps.indexOf(e);n>-1&&t.apps.splice(n,1),t.app===e&&(t.app=t.apps[0]||null),t.app||t.history.teardown()})),!this.app){this.app=e;var n=this.history;if(n instanceof Da||n instanceof Ra){var r=function(e){n.setupListeners(),function(e){var r=n.current,i=t.options.scrollBehavior;va&&i&&"fullPath"in e&&oa(t,e,r,!1)}(e)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(e){t.apps.forEach((function(t){t._route=e}))}))}},Ba.prototype.beforeEach=function(e){return Wa(this.beforeHooks,e)},Ba.prototype.beforeResolve=function(e){return Wa(this.resolveHooks,e)},Ba.prototype.afterEach=function(e){return Wa(this.afterHooks,e)},Ba.prototype.onReady=function(e,t){this.history.onReady(e,t)},Ba.prototype.onError=function(e){this.history.onError(e)},Ba.prototype.push=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.push(e,t,n)}));this.history.push(e,t,n)},Ba.prototype.replace=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.replace(e,t,n)}));this.history.replace(e,t,n)},Ba.prototype.go=function(e){this.history.go(e)},Ba.prototype.back=function(){this.go(-1)},Ba.prototype.forward=function(){this.go(1)},Ba.prototype.getMatchedComponents=function(e){var t=e?e.matched?e:this.resolve(e).route:this.currentRoute;return t?[].concat.apply([],t.matched.map((function(e){return Object.keys(e.components).map((function(t){return e.components[t]}))}))):[]},Ba.prototype.resolve=function(e,t,n){var r=Bo(e,t=t||this.history.current,n,this),i=this.match(r,t),o=i.redirectedFrom||i.fullPath;return{location:r,route:i,href:function(e,t,n){var r="hash"===n?"#"+t:t;return e?Co(e+"/"+r):r}(this.history.base,o,this.mode),normalizedTo:r,resolved:i}},Ba.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ba.prototype.addRoute=function(e,t){this.matcher.addRoute(e,t),this.history.current!==vo&&this.history.transitionTo(this.history.getCurrentLocation())},Ba.prototype.addRoutes=function(e){this.matcher.addRoutes(e),this.history.current!==vo&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ba.prototype,Va);var Ha=Ba;function Wa(e,t){return e.push(t),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}Ba.install=function e(t){if(!e.installed||Vo!==t){e.installed=!0,Vo=t;var n=function(e){return void 0!==e},r=function(e,t){var r=e.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(e,t)};t.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),t.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(t.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(t.prototype,"$route",{get:function(){return this._routerRoot._route}}),t.component("RouterView",_o),t.component("RouterLink",Wo);var i=t.config.optionMergeStrategies;i.beforeRouteEnter=i.beforeRouteLeave=i.beforeRouteUpdate=i.created}},Ba.version="3.6.5",Ba.isNavigationFailure=Ca,Ba.NavigationFailureType=ma,Ba.START_LOCATION=vo,Go&&window.Vue&&window.Vue.use(Ba);n(92);n(90),n(100);var qa={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(15)]).then(n.bind(null,311)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(16)]).then(n.bind(null,252)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(22)]).then(n.bind(null,244)),"components/Home":()=>Promise.all([n.e(0),n.e(18)]).then(n.bind(null,287)),"components/NavLink":()=>n.e(24).then(n.bind(null,241)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(13)]).then(n.bind(null,264)),"components/Navbar":()=>Promise.all([n.e(0),n.e(11)]).then(n.bind(null,286)),"components/Page":()=>Promise.all([n.e(0),n.e(12)]).then(n.bind(null,288)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(19)]).then(n.bind(null,266)),"components/PageNav":()=>Promise.all([n.e(0),n.e(17)]).then(n.bind(null,267)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,308)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,269)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,277)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,270)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,268)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,317)),"global-components/CodeBlock":()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,312)),"global-components/CodeGroup":()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,313)),"layouts/404":()=>n.e(8).then(n.bind(null,314)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,315)),NotFound:()=>n.e(8).then(n.bind(null,314)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,315))},Ga={"v-71b8009e":()=>n.e(84).then(n.bind(null,318)),"v-9cdf0f12":()=>n.e(25).then(n.bind(null,319)),"v-1f9f7b20":()=>n.e(26).then(n.bind(null,320)),"v-3a2b96de":()=>n.e(27).then(n.bind(null,321)),"v-621c7425":()=>n.e(28).then(n.bind(null,322)),"v-4b5593a1":()=>n.e(29).then(n.bind(null,323)),"v-fc2ab00a":()=>n.e(30).then(n.bind(null,324)),"v-b6667cf6":()=>n.e(31).then(n.bind(null,325)),"v-4bc9fdb6":()=>n.e(32).then(n.bind(null,326)),"v-c314465a":()=>n.e(33).then(n.bind(null,327)),"v-a3863eb6":()=>n.e(34).then(n.bind(null,328)),"v-e9fe4e82":()=>n.e(35).then(n.bind(null,329)),"v-375f9eb7":()=>n.e(36).then(n.bind(null,330)),"v-aeb8b1d6":()=>n.e(37).then(n.bind(null,331)),"v-412f6645":()=>n.e(38).then(n.bind(null,332)),"v-1cdcf3a6":()=>n.e(39).then(n.bind(null,333)),"v-f988a616":()=>n.e(40).then(n.bind(null,334)),"v-78732dfa":()=>n.e(41).then(n.bind(null,335)),"v-65dbe632":()=>n.e(42).then(n.bind(null,336)),"v-466fcea5":()=>n.e(43).then(n.bind(null,337)),"v-66508ee2":()=>n.e(44).then(n.bind(null,338)),"v-31ee48e5":()=>n.e(45).then(n.bind(null,339)),"v-7e4d1e45":()=>n.e(46).then(n.bind(null,340)),"v-1f1748ef":()=>n.e(47).then(n.bind(null,341)),"v-e77479e2":()=>n.e(48).then(n.bind(null,342)),"v-5402d2a5":()=>n.e(49).then(n.bind(null,343)),"v-3a8b9d05":()=>n.e(50).then(n.bind(null,344)),"v-791a3817":()=>n.e(51).then(n.bind(null,345)),"v-50fb7326":()=>n.e(52).then(n.bind(null,346)),"v-1b398a8b":()=>n.e(53).then(n.bind(null,347)),"v-a5167bb6":()=>n.e(54).then(n.bind(null,348)),"v-8a34b4ce":()=>n.e(55).then(n.bind(null,349)),"v-1e1b965a":()=>n.e(56).then(n.bind(null,350)),"v-7dd309c5":()=>n.e(57).then(n.bind(null,351)),"v-2fbf6376":()=>n.e(58).then(n.bind(null,352)),"v-06488e03":()=>n.e(59).then(n.bind(null,353)),"v-53c0f549":()=>n.e(60).then(n.bind(null,354)),"v-489e573b":()=>n.e(61).then(n.bind(null,355)),"v-829e8b0e":()=>n.e(62).then(n.bind(null,356)),"v-7850e0a5":()=>n.e(63).then(n.bind(null,357)),"v-6cd4b5a5":()=>n.e(64).then(n.bind(null,358)),"v-3e89a305":()=>n.e(65).then(n.bind(null,359)),"v-0f121225":()=>n.e(66).then(n.bind(null,360)),"v-8a28567a":()=>n.e(67).then(n.bind(null,361)),"v-54d712f6":()=>n.e(68).then(n.bind(null,362)),"v-7c6a3045":()=>n.e(69).then(n.bind(null,363)),"v-d90a38b6":()=>n.e(70).then(n.bind(null,364)),"v-26c53da5":()=>n.e(71).then(n.bind(null,365)),"v-3653dd85":()=>n.e(72).then(n.bind(null,366)),"v-7650e1b6":()=>n.e(73).then(n.bind(null,367)),"v-7dcddcc2":()=>n.e(74).then(n.bind(null,368)),"v-2c054345":()=>n.e(75).then(n.bind(null,369)),"v-e6ef97b6":()=>n.e(76).then(n.bind(null,370)),"v-362e1525":()=>n.e(77).then(n.bind(null,371)),"v-5d69bcd2":()=>n.e(78).then(n.bind(null,372)),"v-656b0965":()=>n.e(79).then(n.bind(null,373)),"v-6f197f91":()=>n.e(80).then(n.bind(null,374)),"v-593f2cf6":()=>n.e(81).then(n.bind(null,375)),"v-5f9445a5":()=>n.e(82).then(n.bind(null,376)),"v-47182957":()=>n.e(83).then(n.bind(null,377))};function Ka(e){const t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}const Ya=/-(\w)/g,Xa=Ka(e=>e.replace(Ya,(e,t)=>t?t.toUpperCase():"")),Za=/\B([A-Z])/g,Ja=Ka(e=>e.replace(Za,"-$1").toLowerCase()),Qa=Ka(e=>e.charAt(0).toUpperCase()+e.slice(1));function el(e,t){if(!t)return;if(e(t))return e(t);return t.includes("-")?e(Qa(Xa(t))):e(Qa(t))||e(Ja(t))}const tl=Object.assign({},qa,Ga),nl=e=>tl[e],rl=e=>Ga[e],il=e=>qa[e],ol=e=>qn.component(e);function al(e){return el(rl,e)}function ll(e){return el(il,e)}function sl(e){return el(nl,e)}function ul(e){return el(ol,e)}function cl(...e){return Promise.all(e.filter(e=>e).map(async e=>{if(!ul(e)&&sl(e)){const t=await sl(e)();qn.component(e,t.default)}}))}function fl(e,t){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[e]=t)}var dl=n(87),pl=n.n(dl),vl=n(88),hl=n.n(vl),gl={created(){if(this.siteMeta=this.$site.headTags.filter(([e])=>"meta"===e).map(([e,t])=>t),this.$ssrContext){const t=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(e=t)?e.map(e=>{let t="{t+=` ${n}="${hl()(e[n])}"`}),t+">"}).join("\n "):"",this.$ssrContext.canonicalLink=yl(this.$canonicalUrl)}var e},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const e=this.getMergedMetaTags();this.currentMetaTags=bl(e,this.currentMetaTags)},getMergedMetaTags(){const e=this.$page.frontmatter.meta||[];return pl()([{name:"description",content:this.$description}],e,this.siteMeta,_l)},updateCanonicalLink(){ml(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",yl(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){bl(null,this.currentMetaTags),ml()}};function ml(){const e=document.querySelector("link[rel='canonical']");e&&e.remove()}function yl(e=""){return e?``:""}function bl(e,t){if(t&&[...t].filter(e=>e.parentNode===document.head).forEach(e=>document.head.removeChild(e)),e)return e.map(e=>{const t=document.createElement("meta");return Object.keys(e).forEach(n=>{t.setAttribute(n,e[n])}),document.head.appendChild(t),t})}function _l(e){for(const t of["name","property","itemprop"])if(e.hasOwnProperty(t))return e[t]+t;return JSON.stringify(e)}var xl=n(89),wl={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(xl)()((function(){this.setActiveHash()}),300),setActiveHash(){const e=[].slice.call(document.querySelectorAll(".sidebar-link")),t=[].slice.call(document.querySelectorAll(".header-anchor")).filter(t=>e.some(e=>e.hash===t.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),i=window.innerHeight+n;for(let e=0;e=o.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},Cl=n(22),Sl=n.n(Cl),kl=[gl,wl,{mounted(){Sl.a.configure({showSpinner:!1}),this.$router.beforeEach((e,t,n)=>{e.path===t.path||qn.component(e.name)||Sl.a.start(),n()}),this.$router.afterEach(()=>{Sl.a.done(),this.isSidebarOpen=!1})}}],Pl={name:"GlobalLayout",computed:{layout(){const e=this.getLayout();return fl("layout",e),qn.component(e)}},methods:{getLayout(){if(this.$page.path){const e=this.$page.frontmatter.layout;return e&&(this.$vuepress.getLayoutAsyncComponent(e)||this.$vuepress.getVueComponent(e))?e:"Layout"}return"NotFound"}}},Ol=n(14),El=Object(Ol.a)(Pl,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(e,t,n){switch(t){case"components":e[t]||(e[t]={}),Object.assign(e[t],n);break;case"mixins":e[t]||(e[t]=[]),e[t].push(...n);break;default:throw new Error("Unknown option name.")}}(El,"mixins",kl);const $l=[{name:"v-71b8009e",path:"/",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-71b8009e").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-9cdf0f12",path:"/api-template.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-9cdf0f12").then(n)}},{name:"v-1f9f7b20",path:"/api/",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1f9f7b20").then(n)}},{path:"/api/index.html",redirect:"/api/"},{name:"v-3a2b96de",path:"/api/classes/config.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3a2b96de").then(n)}},{name:"v-621c7425",path:"/api/classes/emitter.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-621c7425").then(n)}},{name:"v-4b5593a1",path:"/api/classes/hyperformula.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-4b5593a1").then(n)}},{name:"v-fc2ab00a",path:"/api/enums/events.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-fc2ab00a").then(n)}},{name:"v-b6667cf6",path:"/api/globals.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-b6667cf6").then(n)}},{name:"v-4bc9fdb6",path:"/api/interfaces/configparams.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-4bc9fdb6").then(n)}},{name:"v-c314465a",path:"/api/interfaces/listeners.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-c314465a").then(n)}},{name:"v-a3863eb6",path:"/api/interfaces/typedemitter.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-a3863eb6").then(n)}},{name:"v-e9fe4e82",path:"/guide/advanced-usage.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e9fe4e82").then(n)}},{name:"v-375f9eb7",path:"/guide/arrays.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-375f9eb7").then(n)}},{name:"v-aeb8b1d6",path:"/guide/basic-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-aeb8b1d6").then(n)}},{name:"v-412f6645",path:"/guide/basic-usage.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-412f6645").then(n)}},{name:"v-1cdcf3a6",path:"/guide/batch-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1cdcf3a6").then(n)}},{name:"v-f988a616",path:"/guide/branding.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-f988a616").then(n)}},{name:"v-78732dfa",path:"/guide/building.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-78732dfa").then(n)}},{name:"v-65dbe632",path:"/guide/built-in-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-65dbe632").then(n)}},{name:"v-466fcea5",path:"/guide/cell-references.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-466fcea5").then(n)}},{name:"v-66508ee2",path:"/guide/client-side-installation.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-66508ee2").then(n)}},{name:"v-31ee48e5",path:"/guide/clipboard-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-31ee48e5").then(n)}},{name:"v-7e4d1e45",path:"/guide/code-of-conduct.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7e4d1e45").then(n)}},{name:"v-1f1748ef",path:"/guide/compatibility-with-google-sheets.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1f1748ef").then(n)}},{name:"v-e77479e2",path:"/guide/compatibility-with-microsoft-excel.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e77479e2").then(n)}},{name:"v-5402d2a5",path:"/guide/configuration-options.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5402d2a5").then(n)}},{name:"v-3a8b9d05",path:"/guide/contact.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3a8b9d05").then(n)}},{name:"v-791a3817",path:"/guide/contributing.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-791a3817").then(n)}},{name:"v-50fb7326",path:"/guide/custom-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-50fb7326").then(n)}},{name:"v-1b398a8b",path:"/guide/date-and-time-handling.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1b398a8b").then(n)}},{name:"v-a5167bb6",path:"/guide/demo.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-a5167bb6").then(n)}},{name:"v-8a34b4ce",path:"/guide/dependencies.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-8a34b4ce").then(n)}},{name:"v-1e1b965a",path:"/guide/dependency-graph.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1e1b965a").then(n)}},{name:"v-7dd309c5",path:"/guide/file-import.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7dd309c5").then(n)}},{name:"v-2fbf6376",path:"/guide/i18n-features.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-2fbf6376").then(n)}},{name:"v-06488e03",path:"/guide/integration-with-angular.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-06488e03").then(n)}},{name:"v-53c0f549",path:"/guide/integration-with-react.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-53c0f549").then(n)}},{name:"v-489e573b",path:"/guide/integration-with-vue.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-489e573b").then(n)}},{name:"v-829e8b0e",path:"/guide/key-concepts.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-829e8b0e").then(n)}},{name:"v-7850e0a5",path:"/guide/known-limitations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7850e0a5").then(n)}},{name:"v-6cd4b5a5",path:"/guide/license-key.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-6cd4b5a5").then(n)}},{name:"v-3e89a305",path:"/guide/licensing.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3e89a305").then(n)}},{name:"v-0f121225",path:"/guide/list-of-differences.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-0f121225").then(n)}},{name:"v-8a28567a",path:"/guide/localizing-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-8a28567a").then(n)}},{name:"v-54d712f6",path:"/guide/migration-from-0.6-to-1.0.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-54d712f6").then(n)}},{name:"v-7c6a3045",path:"/guide/migration-from-1.0-to-2.0.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7c6a3045").then(n)}},{name:"v-d90a38b6",path:"/guide/named-expressions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-d90a38b6").then(n)}},{name:"v-26c53da5",path:"/guide/order-of-precendece.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-26c53da5").then(n)}},{name:"v-3653dd85",path:"/guide/performance.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3653dd85").then(n)}},{name:"v-7650e1b6",path:"/guide/release-notes.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7650e1b6").then(n)}},{name:"v-7dcddcc2",path:"/guide/server-side-installation.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7dcddcc2").then(n)}},{name:"v-2c054345",path:"/guide/sorting-data.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-2c054345").then(n)}},{name:"v-e6ef97b6",path:"/guide/specifications-and-limits.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e6ef97b6").then(n)}},{name:"v-362e1525",path:"/guide/support.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-362e1525").then(n)}},{name:"v-5d69bcd2",path:"/guide/supported-browsers.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5d69bcd2").then(n)}},{name:"v-656b0965",path:"/guide/types-of-errors.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-656b0965").then(n)}},{name:"v-6f197f91",path:"/guide/types-of-operators.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-6f197f91").then(n)}},{name:"v-593f2cf6",path:"/guide/types-of-values.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-593f2cf6").then(n)}},{name:"v-5f9445a5",path:"/guide/undo-redo.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5f9445a5").then(n)}},{name:"v-47182957",path:"/guide/volatile-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-47182957").then(n)}},{path:"*",component:El}],jl={title:"HyperFormula (v2.6.0)",description:"HyperFormula is an open-source, high-performance calculation engine for spreadsheets and web applications.",base:"/",headTags:[["script",{},"\n (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\n new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\n j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n })(window,document,'script','dataLayer','GTM-N59TZXR');\n "],["meta",{name:"google-site-verification",content:"MZpSOa8SNvFLRRGwUQpYVZ78kIHQoPVdVbafHhJ_d4Q"}],["link",{rel:"apple-touch-icon",sizes:"180x180",href:"/favicon/apple-touch-icon.png"}],["link",{rel:"icon",sizes:"32x32",type:"image/png",href:"/favicon/favicon-32x32.png"}],["link",{rel:"icon",sizes:"16x16",type:"image/png",href:"/favicon/favicon-16x16.png"}],["link",{rel:"manifest",href:"/favicon/site.webmanifest"}],["link",{rel:"mask-icon",color:"#ffffff",href:"/favicon/safari-pinned-tab.svg"}]],pages:[{title:"HyperFormula guide",frontmatter:{description:"HyperFormula® - Complex Calculations Made Easy"},regularPath:"/",relativePath:"index.md",key:"v-71b8009e",path:"/",headers:[{level:2,title:"What is HyperFormula?",slug:"what-is-hyperformula"},{level:2,title:"What can it be used for?",slug:"what-can-it-be-used-for"},{level:2,title:"Resources",slug:"resources"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{frontmatter:{editLink:!1},regularPath:"/api-template.html",relativePath:"api-template.md",key:"v-9cdf0f12",path:"/api-template.html",headers:[{level:3,title:"API reference index",slug:"api-reference-index"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula API reference",frontmatter:{editLink:!1},regularPath:"/api/",relativePath:"api/README.md",key:"v-1f9f7b20",path:"/api/",headers:[{level:3,title:"API reference index",slug:"api-reference-index"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Config",frontmatter:{editLink:!1},regularPath:"/api/classes/config.html",relativePath:"api/classes/config.md",key:"v-3a2b96de",path:"/api/classes/config.html",headers:[{level:2,title:"Constructors",slug:"constructors"},{level:3,title:"constructor",slug:"constructor"},{level:2,title:"Properties",slug:"properties"},{level:3,title:"accentSensitive",slug:"accentsensitive"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold"},{level:3,title:"caseFirst",slug:"casefirst"},{level:3,title:"caseSensitive",slug:"casesensitive"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy"},{level:3,title:"currencySymbol",slug:"currencysymbol"},{level:3,title:"dateFormats",slug:"dateformats"},{level:3,title:"decimalSeparator",slug:"decimalseparator"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero"},{level:3,title:"functionArgSeparator",slug:"functionargseparator"},{level:3,title:"functionPlugins",slug:"functionplugins"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace"},{level:3,title:"language",slug:"language"},{level:3,title:"leapYear1900",slug:"leapyear1900"},{level:3,title:"licenseKey",slug:"licensekey"},{level:3,title:"localeLang",slug:"localelang"},{level:3,title:"matchWholeCell",slug:"matchwholecell"},{level:3,title:"maxColumns",slug:"maxcolumns"},{level:3,title:"maxRows",slug:"maxrows"},{level:3,title:"nullDate",slug:"nulldate"},{level:3,title:"nullYear",slug:"nullyear"},{level:3,title:"parseDateTime",slug:"parsedatetime"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon"},{level:3,title:"precisionRounding",slug:"precisionrounding"},{level:3,title:"smartRounding",slug:"smartrounding"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime"},{level:3,title:"stringifyDuration",slug:"stringifyduration"},{level:3,title:"thousandSeparator",slug:"thousandseparator"},{level:3,title:"timeFormats",slug:"timeformats"},{level:3,title:"undoLimit",slug:"undolimit"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic"},{level:3,title:"useColumnIndex",slug:"usecolumnindex"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions"},{level:3,title:"useStats",slug:"usestats"},{level:3,title:"useWildcards",slug:"usewildcards"},{level:2,title:"Methods",slug:"methods"},{level:3,title:"getConfig",slug:"getconfig"},{level:3,title:"mergeConfig",slug:"mergeconfig"},{level:2,title:"Object literals",slug:"object-literals"},{level:3,title:"defaultConfig",slug:"defaultconfig"},{level:3,title:"▪ defaultConfig: object",slug:"▪-defaultconfig-object"},{level:3,title:"accentSensitive",slug:"accentsensitive-2"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator-2"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator-2"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold-2"},{level:3,title:"caseFirst",slug:"casefirst-2"},{level:3,title:"caseSensitive",slug:"casesensitive-2"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy-2"},{level:3,title:"currencySymbol",slug:"currencysymbol-2"},{level:3,title:"dateFormats",slug:"dateformats-2"},{level:3,title:"decimalSeparator",slug:"decimalseparator-2"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero-2"},{level:3,title:"functionArgSeparator",slug:"functionargseparator-2"},{level:3,title:"functionPlugins",slug:"functionplugins-2"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation-2"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace-2"},{level:3,title:"language",slug:"language-2"},{level:3,title:"leapYear1900",slug:"leapyear1900-2"},{level:3,title:"licenseKey",slug:"licensekey-2"},{level:3,title:"localeLang",slug:"localelang-2"},{level:3,title:"matchWholeCell",slug:"matchwholecell-2"},{level:3,title:"maxColumns",slug:"maxcolumns-2"},{level:3,title:"maxRows",slug:"maxrows-2"},{level:3,title:"nullYear",slug:"nullyear-2"},{level:3,title:"parseDateTime",slug:"parsedatetime-2"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon-2"},{level:3,title:"precisionRounding",slug:"precisionrounding-2"},{level:3,title:"smartRounding",slug:"smartrounding-2"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime-2"},{level:3,title:"stringifyDuration",slug:"stringifyduration-2"},{level:3,title:"thousandSeparator",slug:"thousandseparator-2"},{level:3,title:"timeFormats",slug:"timeformats-2"},{level:3,title:"undoLimit",slug:"undolimit-2"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic-2"},{level:3,title:"useColumnIndex",slug:"usecolumnindex-2"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions-2"},{level:3,title:"useStats",slug:"usestats-2"},{level:3,title:"useWildcards",slug:"usewildcards-2"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Emitter",frontmatter:{editLink:!1},regularPath:"/api/classes/emitter.html",relativePath:"api/classes/emitter.md",key:"v-621c7425",path:"/api/classes/emitter.html",headers:[{level:2,title:"Methods",slug:"methods"},{level:3,title:"emit",slug:"emit"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula",frontmatter:{editLink:!1},regularPath:"/api/classes/hyperformula.html",relativePath:"api/classes/hyperformula.md",key:"v-4b5593a1",path:"/api/classes/hyperformula.html",headers:[{level:2,title:"Static Properties",slug:"static-properties"},{level:3,title:"buildDate",slug:"builddate"},{level:3,title:"languages",slug:"languages"},{level:3,title:"releaseDate",slug:"releasedate"},{level:3,title:"version",slug:"version"},{level:2,title:"Static Accessors",slug:"static-accessors"},{level:3,title:"defaultConfig",slug:"defaultconfig"},{level:2,title:"Factories",slug:"factories"},{level:3,title:"buildEmpty",slug:"buildempty"},{level:3,title:"buildFromArray",slug:"buildfromarray"},{level:3,title:"buildFromSheets",slug:"buildfromsheets"},{level:2,title:"Instance",slug:"instance"},{level:3,title:"destroy",slug:"destroy"},{level:3,title:"getConfig",slug:"getconfig"},{level:3,title:"rebuildAndRecalculate",slug:"rebuildandrecalculate"},{level:3,title:"updateConfig",slug:"updateconfig"},{level:2,title:"Sheets",slug:"sheets"},{level:3,title:"addSheet",slug:"addsheet"},{level:3,title:"clearSheet",slug:"clearsheet"},{level:3,title:"countSheets",slug:"countsheets"},{level:3,title:"doesSheetExist",slug:"doessheetexist"},{level:3,title:"getAllSheetsDimensions",slug:"getallsheetsdimensions"},{level:3,title:"getAllSheetsFormulas",slug:"getallsheetsformulas"},{level:3,title:"getAllSheetsSerialized",slug:"getallsheetsserialized"},{level:3,title:"getAllSheetsValues",slug:"getallsheetsvalues"},{level:3,title:"getSheetDimensions",slug:"getsheetdimensions"},{level:3,title:"getSheetFormulas",slug:"getsheetformulas"},{level:3,title:"getSheetId",slug:"getsheetid"},{level:3,title:"getSheetName",slug:"getsheetname"},{level:3,title:"getSheetNames",slug:"getsheetnames"},{level:3,title:"getSheetSerialized",slug:"getsheetserialized"},{level:3,title:"getSheetValues",slug:"getsheetvalues"},{level:3,title:"isItPossibleToAddSheet",slug:"isitpossibletoaddsheet"},{level:3,title:"isItPossibleToClearSheet",slug:"isitpossibletoclearsheet"},{level:3,title:"isItPossibleToRemoveSheet",slug:"isitpossibletoremovesheet"},{level:3,title:"isItPossibleToRenameSheet",slug:"isitpossibletorenamesheet"},{level:3,title:"isItPossibleToReplaceSheetContent",slug:"isitpossibletoreplacesheetcontent"},{level:3,title:"removeSheet",slug:"removesheet"},{level:3,title:"renameSheet",slug:"renamesheet"},{level:3,title:"setSheetContent",slug:"setsheetcontent"},{level:2,title:"Ranges",slug:"ranges"},{level:3,title:"getFillRangeData",slug:"getfillrangedata"},{level:3,title:"getRangeFormulas",slug:"getrangeformulas"},{level:3,title:"getRangeSerialized",slug:"getrangeserialized"},{level:3,title:"getRangeValues",slug:"getrangevalues"},{level:2,title:"Rows",slug:"rows"},{level:3,title:"addRows",slug:"addrows"},{level:3,title:"isItPossibleToAddRows",slug:"isitpossibletoaddrows"},{level:3,title:"isItPossibleToMoveRows",slug:"isitpossibletomoverows"},{level:3,title:"isItPossibleToRemoveRows",slug:"isitpossibletoremoverows"},{level:3,title:"isItPossibleToSetRowOrder",slug:"isitpossibletosetroworder"},{level:3,title:"isItPossibleToSwapRowIndexes",slug:"isitpossibletoswaprowindexes"},{level:3,title:"moveRows",slug:"moverows"},{level:3,title:"removeRows",slug:"removerows"},{level:3,title:"setRowOrder",slug:"setroworder"},{level:3,title:"swapRowIndexes",slug:"swaprowindexes"},{level:2,title:"Columns",slug:"columns"},{level:3,title:"addColumns",slug:"addcolumns"},{level:3,title:"isItPossibleToAddColumns",slug:"isitpossibletoaddcolumns"},{level:3,title:"isItPossibleToMoveColumns",slug:"isitpossibletomovecolumns"},{level:3,title:"isItPossibleToRemoveColumns",slug:"isitpossibletoremovecolumns"},{level:3,title:"isItPossibleToSetColumnOrder",slug:"isitpossibletosetcolumnorder"},{level:3,title:"isItPossibleToSwapColumnIndexes",slug:"isitpossibletoswapcolumnindexes"},{level:3,title:"moveColumns",slug:"movecolumns"},{level:3,title:"removeColumns",slug:"removecolumns"},{level:3,title:"setColumnOrder",slug:"setcolumnorder"},{level:3,title:"swapColumnIndexes",slug:"swapcolumnindexes"},{level:2,title:"Cells",slug:"cells"},{level:3,title:"doesCellHaveFormula",slug:"doescellhaveformula"},{level:3,title:"doesCellHaveSimpleValue",slug:"doescellhavesimplevalue"},{level:3,title:"getCellFormula",slug:"getcellformula"},{level:3,title:"getCellHyperlink",slug:"getcellhyperlink"},{level:3,title:"getCellSerialized",slug:"getcellserialized"},{level:3,title:"getCellType",slug:"getcelltype"},{level:3,title:"getCellValue",slug:"getcellvalue"},{level:3,title:"getCellValueDetailedType",slug:"getcellvaluedetailedtype"},{level:3,title:"getCellValueFormat",slug:"getcellvalueformat"},{level:3,title:"getCellValueType",slug:"getcellvaluetype"},{level:3,title:"isCellEmpty",slug:"iscellempty"},{level:3,title:"isCellPartOfArray",slug:"iscellpartofarray"},{level:3,title:"isItPossibleToMoveCells",slug:"isitpossibletomovecells"},{level:3,title:"isItPossibleToSetCellContents",slug:"isitpossibletosetcellcontents"},{level:3,title:"moveCells",slug:"movecells"},{level:3,title:"setCellContents",slug:"setcellcontents"},{level:2,title:"Named Expressions",slug:"named-expressions"},{level:3,title:"addNamedExpression",slug:"addnamedexpression"},{level:3,title:"changeNamedExpression",slug:"changenamedexpression"},{level:3,title:"getAllNamedExpressionsSerialized",slug:"getallnamedexpressionsserialized"},{level:3,title:"getNamedExpression",slug:"getnamedexpression"},{level:3,title:"getNamedExpressionFormula",slug:"getnamedexpressionformula"},{level:3,title:"getNamedExpressionValue",slug:"getnamedexpressionvalue"},{level:3,title:"isItPossibleToAddNamedExpression",slug:"isitpossibletoaddnamedexpression"},{level:3,title:"isItPossibleToChangeNamedExpression",slug:"isitpossibletochangenamedexpression"},{level:3,title:"isItPossibleToRemoveNamedExpression",slug:"isitpossibletoremovenamedexpression"},{level:3,title:"listNamedExpressions",slug:"listnamedexpressions"},{level:3,title:"removeNamedExpression",slug:"removenamedexpression"},{level:2,title:"Helpers",slug:"helpers"},{level:3,title:"calculateFormula",slug:"calculateformula"},{level:3,title:"getCellDependents",slug:"getcelldependents"},{level:3,title:"getCellPrecedents",slug:"getcellprecedents"},{level:3,title:"normalizeFormula",slug:"normalizeformula"},{level:3,title:"numberToDate",slug:"numbertodate"},{level:3,title:"numberToDateTime",slug:"numbertodatetime"},{level:3,title:"numberToTime",slug:"numbertotime"},{level:3,title:"simpleCellAddressFromString",slug:"simplecelladdressfromstring"},{level:3,title:"simpleCellAddressToString",slug:"simplecelladdresstostring"},{level:3,title:"simpleCellRangeFromString",slug:"simplecellrangefromstring"},{level:3,title:"simpleCellRangeToString",slug:"simplecellrangetostring"},{level:3,title:"validateFormula",slug:"validateformula"},{level:2,title:"Clipboard",slug:"clipboard"},{level:3,title:"clearClipboard",slug:"clearclipboard"},{level:3,title:"copy",slug:"copy"},{level:3,title:"cut",slug:"cut"},{level:3,title:"isClipboardEmpty",slug:"isclipboardempty"},{level:3,title:"paste",slug:"paste"},{level:2,title:"Undo and Redo",slug:"undo-and-redo"},{level:3,title:"clearRedoStack",slug:"clearredostack"},{level:3,title:"clearUndoStack",slug:"clearundostack"},{level:3,title:"isThereSomethingToRedo",slug:"istheresomethingtoredo"},{level:3,title:"isThereSomethingToUndo",slug:"istheresomethingtoundo"},{level:3,title:"redo",slug:"redo"},{level:3,title:"undo",slug:"undo"},{level:2,title:"Batch",slug:"batch"},{level:3,title:"batch",slug:"batch-2"},{level:3,title:"isEvaluationSuspended",slug:"isevaluationsuspended"},{level:3,title:"resumeEvaluation",slug:"resumeevaluation"},{level:3,title:"suspendEvaluation",slug:"suspendevaluation"},{level:2,title:"Events",slug:"events"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"},{level:2,title:"Custom Functions",slug:"custom-functions"},{level:3,title:"getAllFunctionPlugins",slug:"getallfunctionplugins"},{level:3,title:"getFunctionPlugin",slug:"getfunctionplugin"},{level:3,title:"getRegisteredFunctionNames",slug:"getregisteredfunctionnames"},{level:2,title:"Static Methods",slug:"static-methods"},{level:3,title:"getAllFunctionPlugins",slug:"getallfunctionplugins-2"},{level:3,title:"getFunctionPlugin",slug:"getfunctionplugin-2"},{level:3,title:"getLanguage",slug:"getlanguage"},{level:3,title:"getRegisteredFunctionNames",slug:"getregisteredfunctionnames-2"},{level:3,title:"getRegisteredLanguagesCodes",slug:"getregisteredlanguagescodes"},{level:3,title:"registerFunction",slug:"registerfunction"},{level:3,title:"registerFunctionPlugin",slug:"registerfunctionplugin"},{level:3,title:"registerLanguage",slug:"registerlanguage"},{level:3,title:"unregisterAllFunctions",slug:"unregisterallfunctions"},{level:3,title:"unregisterFunction",slug:"unregisterfunction"},{level:3,title:"unregisterFunctionPlugin",slug:"unregisterfunctionplugin"},{level:3,title:"unregisterLanguage",slug:"unregisterlanguage"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Events",frontmatter:{editLink:!1},regularPath:"/api/enums/events.html",relativePath:"api/enums/events.md",key:"v-fc2ab00a",path:"/api/enums/events.html",headers:[{level:2,title:"Enumeration members",slug:"enumeration-members"},{level:3,title:"EvaluationResumed",slug:"evaluationresumed"},{level:3,title:"EvaluationSuspended",slug:"evaluationsuspended"},{level:3,title:"NamedExpressionAdded",slug:"namedexpressionadded"},{level:3,title:"NamedExpressionRemoved",slug:"namedexpressionremoved"},{level:3,title:"SheetAdded",slug:"sheetadded"},{level:3,title:"SheetRemoved",slug:"sheetremoved"},{level:3,title:"SheetRenamed",slug:"sheetrenamed"},{level:3,title:"ValuesUpdated",slug:"valuesupdated"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula API reference",frontmatter:{editLink:!1},regularPath:"/api/globals.html",relativePath:"api/globals.md",key:"v-b6667cf6",path:"/api/globals.html",headers:[{level:2,title:"Type aliases",slug:"type-aliases"},{level:3,title:"ConfigParamsList",slug:"configparamslist"},{level:2,title:"Variables",slug:"variables"},{level:3,title:"privatePool",slug:"privatepool"},{level:2,title:"Functions",slug:"functions"},{level:3,title:"getDefaultConfig",slug:"getdefaultconfig"},{level:3,title:"getFullConfigFromPartial",slug:"getfullconfigfrompartial"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"ConfigParams",frontmatter:{editLink:!1},regularPath:"/api/interfaces/configparams.html",relativePath:"api/interfaces/configparams.md",key:"v-4bc9fdb6",path:"/api/interfaces/configparams.html",headers:[{level:2,title:"License",slug:"license"},{level:3,title:"licenseKey",slug:"licensekey"},{level:2,title:"Engine",slug:"engine"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero"},{level:3,title:"maxColumns",slug:"maxcolumns"},{level:3,title:"maxRows",slug:"maxrows"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic"},{level:3,title:"useColumnIndex",slug:"usecolumnindex"},{level:3,title:"useStats",slug:"usestats"},{level:2,title:"Formula Syntax",slug:"formula-syntax"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator"},{level:3,title:"functionArgSeparator",slug:"functionargseparator"},{level:3,title:"functionPlugins",slug:"functionplugins"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace"},{level:3,title:"language",slug:"language"},{level:2,title:"Undo and Redo",slug:"undo-and-redo"},{level:3,title:"undoLimit",slug:"undolimit"},{level:2,title:"Date and Time",slug:"date-and-time"},{level:3,title:"dateFormats",slug:"dateformats"},{level:3,title:"leapYear1900",slug:"leapyear1900"},{level:3,title:"nullDate",slug:"nulldate"},{level:3,title:"nullYear",slug:"nullyear"},{level:3,title:"parseDateTime",slug:"parsedatetime"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime"},{level:3,title:"stringifyDuration",slug:"stringifyduration"},{level:3,title:"timeFormats",slug:"timeformats"},{level:2,title:"Number",slug:"number"},{level:3,title:"currencySymbol",slug:"currencysymbol"},{level:3,title:"decimalSeparator",slug:"decimalseparator"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon"},{level:3,title:"precisionRounding",slug:"precisionrounding"},{level:3,title:"smartRounding",slug:"smartrounding"},{level:3,title:"thousandSeparator",slug:"thousandseparator"},{level:2,title:"String",slug:"string"},{level:3,title:"accentSensitive",slug:"accentsensitive"},{level:3,title:"caseFirst",slug:"casefirst"},{level:3,title:"caseSensitive",slug:"casesensitive"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation"},{level:3,title:"localeLang",slug:"localelang"},{level:3,title:"matchWholeCell",slug:"matchwholecell"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions"},{level:3,title:"useWildcards",slug:"usewildcards"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Listeners",frontmatter:{editLink:!1},regularPath:"/api/interfaces/listeners.html",relativePath:"api/interfaces/listeners.md",key:"v-c314465a",path:"/api/interfaces/listeners.html",headers:[{level:2,title:"Batch",slug:"batch"},{level:3,title:"evaluationResumed",slug:"evaluationresumed"},{level:3,title:"evaluationSuspended",slug:"evaluationsuspended"},{level:2,title:"Named Expression",slug:"named-expression"},{level:3,title:"namedExpressionAdded",slug:"namedexpressionadded"},{level:3,title:"namedExpressionRemoved",slug:"namedexpressionremoved"},{level:2,title:"Sheet",slug:"sheet"},{level:3,title:"sheetAdded",slug:"sheetadded"},{level:3,title:"sheetRemoved",slug:"sheetremoved"},{level:3,title:"sheetRenamed",slug:"sheetrenamed"},{level:2,title:"Values",slug:"values"},{level:3,title:"valuesUpdated",slug:"valuesupdated"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"TypedEmitter",frontmatter:{editLink:!1},regularPath:"/api/interfaces/typedemitter.html",relativePath:"api/interfaces/typedemitter.md",key:"v-a3863eb6",path:"/api/interfaces/typedemitter.html",headers:[{level:2,title:"Methods",slug:"methods"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Advanced usage",frontmatter:{},regularPath:"/guide/advanced-usage.html",relativePath:"guide/advanced-usage.md",key:"v-e9fe4e82",path:"/guide/advanced-usage.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Array formulas",frontmatter:{},regularPath:"/guide/arrays.html",relativePath:"guide/arrays.md",key:"v-375f9eb7",path:"/guide/arrays.html",headers:[{level:2,title:"About arrays",slug:"about-arrays"},{level:3,title:"Inline arrays",slug:"inline-arrays"},{level:2,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Enabling the array arithmetic mode locally",slug:"enabling-the-array-arithmetic-mode-locally"},{level:3,title:"Enabling the array arithmetic mode globally",slug:"enabling-the-array-arithmetic-mode-globally"},{level:2,title:"Array features",slug:"array-features"},{level:3,title:"Operating on arrays",slug:"operating-on-arrays"},{level:3,title:"Passing arrays to scalar functions (vectorization)",slug:"passing-arrays-to-scalar-functions-vectorization"},{level:3,title:"Broadcasting",slug:"broadcasting"},{level:3,title:"Filtering an array",slug:"filtering-an-array"},{level:3,title:"Constraining an array's size",slug:"constraining-an-array-s-size"},{level:2,title:"Array rules",slug:"array-rules"},{level:3,title:"With the array arithmetic mode enabled",slug:"with-the-array-arithmetic-mode-enabled"},{level:3,title:"With the array arithmetic mode disabled",slug:"with-the-array-arithmetic-mode-disabled"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Basic operations",frontmatter:{},regularPath:"/guide/basic-operations.html",relativePath:"guide/basic-operations.md",key:"v-aeb8b1d6",path:"/guide/basic-operations.html",headers:[{level:2,title:"Sheets",slug:"sheets"},{level:3,title:"Adding a sheet",slug:"adding-a-sheet"},{level:3,title:"Removing a sheet",slug:"removing-a-sheet"},{level:3,title:"Renaming a sheet",slug:"renaming-a-sheet"},{level:3,title:"Clearing a sheet",slug:"clearing-a-sheet"},{level:3,title:"Replacing sheet content",slug:"replacing-sheet-content"},{level:2,title:"Rows",slug:"rows"},{level:3,title:"Adding rows",slug:"adding-rows"},{level:3,title:"Removing rows",slug:"removing-rows"},{level:3,title:"Moving rows",slug:"moving-rows"},{level:3,title:"Reordering rows",slug:"reordering-rows"},{level:2,title:"Columns",slug:"columns"},{level:3,title:"Adding columns",slug:"adding-columns"},{level:3,title:"Removing columns",slug:"removing-columns"},{level:3,title:"Moving columns",slug:"moving-columns"},{level:3,title:"Reordering columns",slug:"reordering-columns"},{level:2,title:"Cells",slug:"cells"},{level:3,title:"Moving cells",slug:"moving-cells"},{level:3,title:"Updating cells",slug:"updating-cells"},{level:3,title:"Getting cell value",slug:"getting-cell-value"},{level:3,title:"Getting cell formula",slug:"getting-cell-formula"},{level:2,title:"Handling an error",slug:"handling-an-error"},{level:2,title:"isItPossibleTo* methods",slug:"isitpossibleto-methods"},{level:2,title:'What are the "changes"?',slug:"what-are-the-changes"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Basic usage",frontmatter:{},regularPath:"/guide/basic-usage.html",relativePath:"guide/basic-usage.md",key:"v-412f6645",path:"/guide/basic-usage.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Batch operations",frontmatter:{},regularPath:"/guide/batch-operations.html",relativePath:"guide/batch-operations.md",key:"v-1cdcf3a6",path:"/guide/batch-operations.html",headers:[{level:2,title:"How to batch",slug:"how-to-batch"},{level:3,title:"Using the batch method",slug:"using-the-batch-method"},{level:3,title:"Using the suspendEvaluation and resumeEvaluation methods",slug:"using-the-suspendevaluation-and-resumeevaluation-methods"},{level:3,title:"Adjusting need with the isEvaluationSuspended method",slug:"adjusting-need-with-the-isevaluationsuspended-method"},{level:2,title:"When to batch",slug:"when-to-batch"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Branding",frontmatter:{},regularPath:"/guide/branding.html",relativePath:"guide/branding.md",key:"v-f988a616",path:"/guide/branding.html",headers:[{level:2,title:"Our logo",slug:"our-logo"},{level:2,title:"Logotype",slug:"logotype"},{level:2,title:"Resources",slug:"resources"},{level:2,title:"Terms of use",slug:"terms-of-use"},{level:2,title:"Trademark protection",slug:"trademark-protection"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Building",frontmatter:{},regularPath:"/guide/building.html",relativePath:"guide/building.md",key:"v-78732dfa",path:"/guide/building.html",headers:[{level:2,title:"Build the project",slug:"build-the-project"},{level:2,title:"Verify the build",slug:"verify-the-build"},{level:2,title:"Build the documentation",slug:"build-the-documentation"},{level:2,title:"Run the tests",slug:"run-the-tests"},{level:2,title:"Run the linter",slug:"run-the-linter"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Built-in functions",frontmatter:{},regularPath:"/guide/built-in-functions.html",relativePath:"guide/built-in-functions.md",key:"v-65dbe632",path:"/guide/built-in-functions.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"List of available functions",slug:"list-of-available-functions"},{level:3,title:"Array manipulation",slug:"array-manipulation"},{level:3,title:"Date and time",slug:"date-and-time"},{level:3,title:"Engineering",slug:"engineering"},{level:3,title:"Information",slug:"information"},{level:3,title:"Financial",slug:"financial"},{level:3,title:"Logical",slug:"logical"},{level:3,title:"Lookup and reference",slug:"lookup-and-reference"},{level:3,title:"Math and trigonometry",slug:"math-and-trigonometry"},{level:3,title:"Matrix functions",slug:"matrix-functions"},{level:3,title:"Operator",slug:"operator"},{level:3,title:"Statistical",slug:"statistical"},{level:3,title:"Text",slug:"text"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Cell references",frontmatter:{},regularPath:"/guide/cell-references.html",relativePath:"guide/cell-references.md",key:"v-466fcea5",path:"/guide/cell-references.html",headers:[{level:3,title:"Referring to named expressions",slug:"referring-to-named-expressions"},{level:2,title:"Relative references",slug:"relative-references"},{level:2,title:"Absolute references",slug:"absolute-references"},{level:2,title:"Range references",slug:"range-references"},{level:3,title:"Range definition",slug:"range-definition"},{level:3,title:"Range types",slug:"range-types"},{level:3,title:"Referencing ranges",slug:"referencing-ranges"},{level:3,title:"Range restraints",slug:"range-restraints"},{level:3,title:"More about ranges",slug:"more-about-ranges"},{level:2,title:"Circular references",slug:"circular-references"},{level:2,title:"The #REF! error",slug:"the-ref-error"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Client-side installation",frontmatter:{},regularPath:"/guide/client-side-installation.html",relativePath:"guide/client-side-installation.md",key:"v-66508ee2",path:"/guide/client-side-installation.html",headers:[{level:3,title:"Install with npm or Yarn",slug:"install-with-npm-or-yarn"},{level:2,title:"Use CDN",slug:"use-cdn"},{level:2,title:"Clone from GitHub",slug:"clone-from-github"},{level:3,title:"Clone with HTTPS",slug:"clone-with-https"},{level:3,title:"Clone with SSH",slug:"clone-with-ssh"},{level:2,title:"Download from GitHub",slug:"download-from-github"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Clipboard operations",frontmatter:{},regularPath:"/guide/clipboard-operations.html",relativePath:"guide/clipboard-operations.md",key:"v-31ee48e5",path:"/guide/clipboard-operations.html",headers:[{level:2,title:"Copy",slug:"copy"},{level:2,title:"Cut",slug:"cut"},{level:2,title:"Paste",slug:"paste"},{level:3,title:"Copy and paste",slug:"copy-and-paste"},{level:3,title:"Cut and paste",slug:"cut-and-paste"},{level:2,title:"Clear the clipboard",slug:"clear-the-clipboard"},{level:2,title:"Data storage",slug:"data-storage"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Code of conduct",frontmatter:{},regularPath:"/guide/code-of-conduct.html",relativePath:"guide/code-of-conduct.md",key:"v-7e4d1e45",path:"/guide/code-of-conduct.html",headers:[{level:2,title:"Our Pledge",slug:"our-pledge"},{level:2,title:"Our Standards",slug:"our-standards"},{level:2,title:"Enforcement Responsibilities",slug:"enforcement-responsibilities"},{level:2,title:"Scope",slug:"scope"},{level:2,title:"Enforcement",slug:"enforcement"},{level:2,title:"Enforcement Guidelines",slug:"enforcement-guidelines"},{level:3,title:"1. Correction",slug:"_1-correction"},{level:3,title:"2. Warning",slug:"_2-warning"},{level:3,title:"3. Temporary Ban",slug:"_3-temporary-ban"},{level:3,title:"4. Permanent Ban",slug:"_4-permanent-ban"},{level:2,title:"Attribution",slug:"attribution"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Compatibility with Google Sheets",frontmatter:{},regularPath:"/guide/compatibility-with-google-sheets.html",relativePath:"guide/compatibility-with-google-sheets.md",key:"v-1f1748ef",path:"/guide/compatibility-with-google-sheets.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Configure compatibility with Google Sheets",slug:"configure-compatibility-with-google-sheets"},{level:3,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Leap year bug",slug:"leap-year-bug"},{level:3,title:"Numerical precision",slug:"numerical-precision"},{level:3,title:"Separators",slug:"separators"},{level:3,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Full configuration",slug:"full-configuration"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Compatibility with Microsoft Excel",frontmatter:{},regularPath:"/guide/compatibility-with-microsoft-excel.html",relativePath:"guide/compatibility-with-microsoft-excel.md",key:"v-e77479e2",path:"/guide/compatibility-with-microsoft-excel.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Configure compatibility with Microsoft Excel",slug:"configure-compatibility-with-microsoft-excel"},{level:3,title:"String comparison rules",slug:"string-comparison-rules"},{level:3,title:"Function criteria",slug:"function-criteria"},{level:3,title:"TRUE and FALSE constants",slug:"true-and-false-constants"},{level:3,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Whitespace in formulas",slug:"whitespace-in-formulas"},{level:3,title:"Formulas that evaluate to null",slug:"formulas-that-evaluate-to-null"},{level:3,title:"Leap year bug",slug:"leap-year-bug"},{level:3,title:"Numerical precision",slug:"numerical-precision"},{level:3,title:"Separators",slug:"separators"},{level:3,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Full configuration",slug:"full-configuration"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Configuration options",frontmatter:{},regularPath:"/guide/configuration-options.html",relativePath:"guide/configuration-options.md",key:"v-5402d2a5",path:"/guide/configuration-options.html",headers:[{level:2,title:"Example",slug:"example"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Contact",frontmatter:{},regularPath:"/guide/contact.html",relativePath:"guide/contact.md",key:"v-3a8b9d05",path:"/guide/contact.html",headers:[{level:2,title:"Contact sales",slug:"contact-sales"},{level:2,title:"Billing address",slug:"billing-address"},{level:2,title:"Looking for technical support?",slug:"looking-for-technical-support"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Contributing",frontmatter:{},regularPath:"/guide/contributing.html",relativePath:"guide/contributing.md",key:"v-791a3817",path:"/guide/contributing.html",headers:[{level:2,title:"Good first issue",slug:"good-first-issue"},{level:2,title:"How to get started",slug:"how-to-get-started"},{level:2,title:"Code of conduct",slug:"code-of-conduct"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Custom functions",frontmatter:{},regularPath:"/guide/custom-functions.html",relativePath:"guide/custom-functions.md",key:"v-50fb7326",path:"/guide/custom-functions.html",headers:[{level:2,title:"Add a simple custom function",slug:"add-a-simple-custom-function"},{level:3,title:"1. Create a function plugin",slug:"_1-create-a-function-plugin"},{level:3,title:"2. Define your function's ID, method, and metadata",slug:"_2-define-your-function-s-id-method-and-metadata"},{level:3,title:"3. Add your function's names",slug:"_3-add-your-function-s-names"},{level:3,title:"4. Implement your function's logic",slug:"_4-implement-your-function-s-logic"},{level:3,title:"5. Register your function plugin",slug:"_5-register-your-function-plugin"},{level:3,title:"6. Use your custom function in a formula",slug:"_6-use-your-custom-function-in-a-formula"},{level:3,title:"Full example",slug:"full-example"},{level:2,title:"Advanced custom function example",slug:"advanced-custom-function-example"},{level:3,title:"Accept a range argument",slug:"accept-a-range-argument"},{level:3,title:"Return an array of data",slug:"return-an-array-of-data"},{level:3,title:"Validate the arguments and return an error",slug:"validate-the-arguments-and-return-an-error"},{level:3,title:"Test your function",slug:"test-your-function"},{level:2,title:"Working demo",slug:"working-demo"},{level:2,title:"Function options",slug:"function-options"},{level:3,title:"Argument validation options",slug:"argument-validation-options"},{level:3,title:"Types of the function argument",slug:"types-of-the-function-argument"},{level:3,title:"Handling missing arguments",slug:"handling-missing-arguments"},{level:2,title:"Function name translations",slug:"function-name-translations"},{level:2,title:"Function aliases",slug:"function-aliases"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Date and time handling",frontmatter:{},regularPath:"/guide/date-and-time-handling.html",relativePath:"guide/date-and-time-handling.md",key:"v-1b398a8b",path:"/guide/date-and-time-handling.html",headers:[{level:2,title:"Example",slug:"example"},{level:2,title:"Custom date and time handling",slug:"custom-date-and-time-handling"},{level:2,title:"Moment.js integration",slug:"moment-js-integration"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Demo",frontmatter:{},regularPath:"/guide/demo.html",relativePath:"guide/demo.md",key:"v-a5167bb6",path:"/guide/demo.html",version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Dependencies",frontmatter:{},regularPath:"/guide/dependencies.html",relativePath:"guide/dependencies.md",key:"v-8a34b4ce",path:"/guide/dependencies.html",version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Dependency graph",frontmatter:{},regularPath:"/guide/dependency-graph.html",relativePath:"guide/dependency-graph.md",key:"v-1e1b965a",path:"/guide/dependency-graph.html",headers:[{level:2,title:"Cells in the dependency graph",slug:"cells-in-the-dependency-graph"},{level:2,title:"Ranges in the dependency graph",slug:"ranges-in-the-dependency-graph"},{level:3,title:"Optimizations for large ranges",slug:"optimizations-for-large-ranges"},{level:2,title:"Getting the immediate precedents of a cell or a range",slug:"getting-the-immediate-precedents-of-a-cell-or-a-range"},{level:2,title:"Getting the immediate dependents of a cell or a range",slug:"getting-the-immediate-dependents-of-a-cell-or-a-range"},{level:2,title:"Getting all precedents of a cell or a range",slug:"getting-all-precedents-of-a-cell-or-a-range"},{level:2,title:"Getting all dependents of a cell or a range",slug:"getting-all-dependents-of-a-cell-or-a-range"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"File import",frontmatter:{},regularPath:"/guide/file-import.html",relativePath:"guide/file-import.md",key:"v-7dd309c5",path:"/guide/file-import.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Import CSV files",slug:"import-csv-files"},{level:2,title:"Import XLSX files",slug:"import-xlsx-files"},{level:3,title:"Example: Import XLSX files in Node",slug:"example-import-xlsx-files-in-node"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Internationalization features",frontmatter:{},regularPath:"/guide/i18n-features.html",relativePath:"guide/i18n-features.md",key:"v-2fbf6376",path:"/guide/i18n-features.html",headers:[{level:2,title:"Function names and errors",slug:"function-names-and-errors"},{level:2,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Number format",slug:"number-format"},{level:2,title:"Currency symbol",slug:"currency-symbol"},{level:2,title:"String comparison rules",slug:"string-comparison-rules"},{level:2,title:"Compatibility with other spreadsheet software",slug:"compatibility-with-other-spreadsheet-software"},{level:2,title:"en-US configuration",slug:"en-us-configuration"},{level:2,title:"en-US demo",slug:"en-us-demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with Angular",frontmatter:{},regularPath:"/guide/integration-with-angular.html",relativePath:"guide/integration-with-angular.md",key:"v-06488e03",path:"/guide/integration-with-angular.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with React",frontmatter:{},regularPath:"/guide/integration-with-react.html",relativePath:"guide/integration-with-react.md",key:"v-53c0f549",path:"/guide/integration-with-react.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with Vue",frontmatter:{},regularPath:"/guide/integration-with-vue.html",relativePath:"guide/integration-with-vue.md",key:"v-489e573b",path:"/guide/integration-with-vue.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Key concepts",frontmatter:{},regularPath:"/guide/key-concepts.html",relativePath:"guide/key-concepts.md",key:"v-829e8b0e",path:"/guide/key-concepts.html",headers:[{level:2,title:"High-level design diagram",slug:"high-level-design-diagram"},{level:2,title:"Phase 1. Parsing and construction of ASTs",slug:"phase-1-parsing-and-construction-of-asts"},{level:2,title:"Phase 2. Construction of the dependency graph",slug:"phase-2-construction-of-the-dependency-graph"},{level:2,title:"Phase 3. Evaluation",slug:"phase-3-evaluation"},{level:2,title:"Grammar",slug:"grammar"},{level:2,title:"Repetitive ASTs",slug:"repetitive-asts"},{level:2,title:"Relative addressing",slug:"relative-addressing"},{level:2,title:"Laziness of CRUD operations",slug:"laziness-of-crud-operations"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Known limitations",frontmatter:{},regularPath:"/guide/known-limitations.html",relativePath:"guide/known-limitations.md",key:"v-7850e0a5",path:"/guide/known-limitations.html",headers:[{level:2,title:"Nuances of the implemented functions",slug:"nuances-of-the-implemented-functions"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"License key",frontmatter:{},regularPath:"/guide/license-key.html",relativePath:"guide/license-key.md",key:"v-6cd4b5a5",path:"/guide/license-key.html",headers:[{level:2,title:"GPLv3 license",slug:"gplv3-license"},{level:2,title:"Commercial license",slug:"commercial-license"},{level:3,title:"Commercial license key validation",slug:"commercial-license-key-validation"},{level:2,title:"License key notifications",slug:"license-key-notifications"},{level:2,title:"License key support",slug:"license-key-support"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Licensing",frontmatter:{},regularPath:"/guide/licensing.html",relativePath:"guide/licensing.md",key:"v-3e89a305",path:"/guide/licensing.html",headers:[{level:2,title:"Available licenses",slug:"available-licenses"},{level:2,title:"Non-commercial and open-source use",slug:"non-commercial-and-open-source-use"},{level:2,title:"Commercial use",slug:"commercial-use"},{level:2,title:"Entering a license key",slug:"entering-a-license-key"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"List of differences with other spreadsheets",frontmatter:{},regularPath:"/guide/list-of-differences.html",relativePath:"guide/list-of-differences.md",key:"v-0f121225",path:"/guide/list-of-differences.html",headers:[{level:2,title:"General functionalities",slug:"general-functionalities"},{level:2,title:"Built-in functions",slug:"built-in-functions"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Localizing functions",frontmatter:{},regularPath:"/guide/localizing-functions.html",relativePath:"guide/localizing-functions.md",key:"v-8a28567a",path:"/guide/localizing-functions.html",headers:[{level:2,title:"Localizing custom functions",slug:"localizing-custom-functions"},{level:3,title:"List of supported languages",slug:"list-of-supported-languages"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Migrating from 0.6 to 1.0",frontmatter:{},regularPath:"/guide/migration-from-0.6-to-1.0.html",relativePath:"guide/migration-from-0.6-to-1.0.md",key:"v-54d712f6",path:"/guide/migration-from-0.6-to-1.0.html",headers:[{level:2,title:"Step 1: Change your license key",slug:"step-1-change-your-license-key"},{level:3,title:"Open-source license",slug:"open-source-license"},{level:3,title:"Free non-commercial license",slug:"free-non-commercial-license"},{level:2,title:"Step 2: Change sheetName to sheetId",slug:"step-2-change-sheetname-to-sheetid"},{level:2,title:"Step 3: Adapt to the matrix->array name changes",slug:"step-3-adapt-to-the-matrix-array-name-changes"},{level:3,title:"Configuration option names",slug:"configuration-option-names"},{level:3,title:"API method names",slug:"api-method-names"},{level:3,title:"Exception names",slug:"exception-names"},{level:2,title:"Step 4: Drop the matrix formula notation",slug:"step-4-drop-the-matrix-formula-notation"},{level:2,title:"Step 5: Drop the matrixDetection and matrixDetectionThreshold options",slug:"step-5-drop-the-matrixdetection-and-matrixdetectionthreshold-options"},{level:2,title:"Step 6: Switch to the SimpleCellRange type argument",slug:"step-6-switch-to-the-simplecellrange-type-argument"},{level:2,title:"Step 7: Adapt to the array changes",slug:"step-7-adapt-to-the-array-changes"},{level:3,title:"setCellContents()",slug:"setcellcontents"},{level:3,title:"addRows() and removeRows()",slug:"addrows-and-removerows"},{level:3,title:"addColumns() and removeColumns()",slug:"addcolumns-and-removecolumns"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Migrating from 1.x to 2.0",frontmatter:{},regularPath:"/guide/migration-from-1.0-to-2.0.html",relativePath:"guide/migration-from-1.0-to-2.0.md",key:"v-7c6a3045",path:"/guide/migration-from-1.0-to-2.0.html",headers:[{level:2,title:"Drop the gpujs and gpuMode options",slug:"drop-the-gpujs-and-gpumode-options"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Named expressions",frontmatter:{},regularPath:"/guide/named-expressions.html",relativePath:"guide/named-expressions.md",key:"v-d90a38b6",path:"/guide/named-expressions.html",headers:[{level:2,title:"Examples",slug:"examples"},{level:2,title:"Naming rules",slug:"naming-rules"},{level:2,title:"Available methods",slug:"available-methods"},{level:3,title:"Adding a named expression",slug:"adding-a-named-expression"},{level:3,title:"Changing a named expression",slug:"changing-a-named-expression"},{level:3,title:"Removing a named expression",slug:"removing-a-named-expression"},{level:3,title:"Listing all named expressions",slug:"listing-all-named-expressions"},{level:2,title:"Handling errors",slug:"handling-errors"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Order of precedence",frontmatter:{},regularPath:"/guide/order-of-precendece.html",relativePath:"guide/order-of-precendece.md",key:"v-26c53da5",path:"/guide/order-of-precendece.html",headers:[{level:2,title:"Table of precedence",slug:"table-of-precedence"},{level:2,title:"Using parentheses",slug:"using-parentheses"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Performance",frontmatter:{},regularPath:"/guide/performance.html",relativePath:"guide/performance.md",key:"v-3653dd85",path:"/guide/performance.html",headers:[{level:2,title:"VLOOKUP/MATCH",slug:"vlookup-match"},{level:2,title:"Address mapping strategies",slug:"address-mapping-strategies"},{level:2,title:"Suspending automatic recalculations",slug:"suspending-automatic-recalculations"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Release notes",frontmatter:{},regularPath:"/guide/release-notes.html",relativePath:"guide/release-notes.md",key:"v-7650e1b6",path:"/guide/release-notes.html",headers:[{level:2,title:"2.6.0",slug:"_2-6-0"},{level:3,title:"Added",slug:"added"},{level:3,title:"Changed",slug:"changed"},{level:3,title:"Fixed",slug:"fixed"},{level:2,title:"2.5.0",slug:"_2-5-0"},{level:3,title:"Added",slug:"added-2"},{level:3,title:"Changed",slug:"changed-2"},{level:3,title:"Fixed",slug:"fixed-2"},{level:2,title:"2.4.0",slug:"_2-4-0"},{level:3,title:"Added",slug:"added-3"},{level:3,title:"Fixed",slug:"fixed-3"},{level:2,title:"2.3.1",slug:"_2-3-1"},{level:3,title:"Fixed",slug:"fixed-4"},{level:2,title:"2.3.0",slug:"_2-3-0"},{level:3,title:"Added",slug:"added-4"},{level:2,title:"2.2.0",slug:"_2-2-0"},{level:3,title:"Added",slug:"added-5"},{level:3,title:"Fixed",slug:"fixed-5"},{level:2,title:"2.1.0",slug:"_2-1-0"},{level:3,title:"Added",slug:"added-6"},{level:3,title:"Changed",slug:"changed-3"},{level:3,title:"Fixed",slug:"fixed-6"},{level:3,title:"Removed",slug:"removed"},{level:2,title:"2.0.1",slug:"_2-0-1"},{level:3,title:"Changed",slug:"changed-4"},{level:3,title:"Fixed",slug:"fixed-7"},{level:2,title:"2.0.0",slug:"_2-0-0"},{level:3,title:"Added",slug:"added-7"},{level:3,title:"Changed",slug:"changed-5"},{level:3,title:"Fixed",slug:"fixed-8"},{level:2,title:"1.3.1",slug:"_1-3-1"},{level:3,title:"Fixed",slug:"fixed-9"},{level:2,title:"1.3.0",slug:"_1-3-0"},{level:3,title:"Added",slug:"added-8"},{level:3,title:"Fixed",slug:"fixed-10"},{level:2,title:"1.2.0",slug:"_1-2-0"},{level:3,title:"Changed",slug:"changed-6"},{level:2,title:"1.1.0",slug:"_1-1-0"},{level:3,title:"Added",slug:"added-9"},{level:3,title:"Changed",slug:"changed-7"},{level:3,title:"Fixed",slug:"fixed-11"},{level:2,title:"1.0.0",slug:"_1-0-0"},{level:3,title:"Added",slug:"added-10"},{level:3,title:"Changed",slug:"changed-8"},{level:3,title:"Fixed",slug:"fixed-12"},{level:2,title:"0.6.2",slug:"_0-6-2"},{level:3,title:"Changed",slug:"changed-9"},{level:2,title:"0.6.1",slug:"_0-6-1"},{level:3,title:"Changed",slug:"changed-10"},{level:3,title:"Fixed",slug:"fixed-13"},{level:2,title:"0.6.0",slug:"_0-6-0"},{level:3,title:"Added",slug:"added-11"},{level:3,title:"Changed",slug:"changed-11"},{level:3,title:"Fixed",slug:"fixed-14"},{level:2,title:"0.5.0",slug:"_0-5-0"},{level:3,title:"Added",slug:"added-12"},{level:3,title:"Changed",slug:"changed-12"},{level:3,title:"Fixed",slug:"fixed-15"},{level:2,title:"0.4.0",slug:"_0-4-0"},{level:3,title:"Added",slug:"added-13"},{level:3,title:"Changed",slug:"changed-13"},{level:3,title:"Fixed",slug:"fixed-16"},{level:2,title:"0.3.0",slug:"_0-3-0"},{level:3,title:"Added",slug:"added-14"},{level:3,title:"Fixed",slug:"fixed-17"},{level:2,title:"0.2.0",slug:"_0-2-0"},{level:3,title:"Added",slug:"added-15"},{level:3,title:"Changed",slug:"changed-14"},{level:3,title:"Fixed",slug:"fixed-18"},{level:2,title:"0.1.3",slug:"_0-1-3"},{level:3,title:"Fixed",slug:"fixed-19"},{level:2,title:"0.1.2",slug:"_0-1-2"},{level:3,title:"Fixed",slug:"fixed-20"},{level:2,title:"0.1.1",slug:"_0-1-1"},{level:3,title:"Fixed",slug:"fixed-21"},{level:2,title:"0.1.0",slug:"_0-1-0"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Server-side installation",frontmatter:{},regularPath:"/guide/server-side-installation.html",relativePath:"guide/server-side-installation.md",key:"v-7dcddcc2",path:"/guide/server-side-installation.html",headers:[{level:2,title:"Install with npm or Yarn",slug:"install-with-npm-or-yarn"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Sorting data",frontmatter:{},regularPath:"/guide/sorting-data.html",relativePath:"guide/sorting-data.md",key:"v-2c054345",path:"/guide/sorting-data.html",headers:[{level:2,title:"Sorting data in HyperFormula",slug:"sorting-data-in-hyperformula"},{level:2,title:"Sorting rows",slug:"sorting-rows"},{level:3,title:"Step 1: Choose a new row order",slug:"step-1-choose-a-new-row-order"},{level:3,title:"Step 2: Check if the new row order can be applied",slug:"step-2-check-if-the-new-row-order-can-be-applied"},{level:3,title:"Step 3: Set the new row order",slug:"step-3-set-the-new-row-order"},{level:2,title:"Sorting columns",slug:"sorting-columns"},{level:3,title:"Step 1: Choose a new column order",slug:"step-1-choose-a-new-column-order"},{level:3,title:"Step 2: Check if the new column order can be applied",slug:"step-2-check-if-the-new-column-order-can-be-applied"},{level:3,title:"Step 3: Set the new column order",slug:"step-3-set-the-new-column-order"},{level:2,title:"Data sorting demo",slug:"data-sorting-demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Specifications and limits",frontmatter:{},regularPath:"/guide/specifications-and-limits.html",relativePath:"guide/specifications-and-limits.md",key:"v-e6ef97b6",path:"/guide/specifications-and-limits.html",headers:[{level:2,title:"Sheet and cell limits",slug:"sheet-and-cell-limits"},{level:2,title:"Calculation limits",slug:"calculation-limits"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Support",frontmatter:{},regularPath:"/guide/support.html",relativePath:"guide/support.md",key:"v-362e1525",path:"/guide/support.html",headers:[{level:2,title:"Community support",slug:"community-support"},{level:2,title:"Premium support",slug:"premium-support"},{level:2,title:"Consulting services",slug:"consulting-services"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Supported browsers",frontmatter:{},regularPath:"/guide/supported-browsers.html",relativePath:"guide/supported-browsers.md",key:"v-5d69bcd2",path:"/guide/supported-browsers.html",headers:[{level:2,title:"List of supported browsers",slug:"list-of-supported-browsers"},{level:2,title:"Full ICU support",slug:"full-icu-support"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of errors",frontmatter:{},regularPath:"/guide/types-of-errors.html",relativePath:"guide/types-of-errors.md",key:"v-656b0965",path:"/guide/types-of-errors.html",version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of operators",frontmatter:{},regularPath:"/guide/types-of-operators.html",relativePath:"guide/types-of-operators.md",key:"v-6f197f91",path:"/guide/types-of-operators.html",headers:[{level:2,title:"Unary operators",slug:"unary-operators"},{level:2,title:"Binary arithmetic operators",slug:"binary-arithmetic-operators"},{level:2,title:"Comparison operators",slug:"comparison-operators"},{level:3,title:"Type coercion",slug:"type-coercion"},{level:2,title:"Boolean to int coercion, basic arithmetic operations",slug:"boolean-to-int-coercion-basic-arithmetic-operations"},{level:3,title:"a) true and null",slug:"a-true-and-null"},{level:3,title:"b) null and true",slug:"b-null-and-true"},{level:3,title:"c) true and true",slug:"c-true-and-true"},{level:3,title:"d) false and true",slug:"d-false-and-true"},{level:3,title:"e) true and false",slug:"e-true-and-false"},{level:3,title:"f) false and false",slug:"f-false-and-false"},{level:3,title:"g) null and false",slug:"g-null-and-false"},{level:2,title:"Order operations, comparisons",slug:"order-operations-comparisons"},{level:3,title:'a) Empty string ("") and null',slug:"a-empty-string-and-null"},{level:3,title:'b) String ("string") and boolean',slug:"b-string-string-and-boolean"},{level:3,title:"c) Null and false",slug:"c-null-and-false"},{level:3,title:"d) Null and positive integer",slug:"d-null-and-positive-integer"},{level:3,title:"e) Negative integer and null",slug:"e-negative-integer-and-null"},{level:3,title:"f) 0 and null",slug:"f-0-and-null"},{level:3,title:"g) 0 and false",slug:"g-0-and-false"},{level:3,title:"h) Positive integer and true",slug:"h-positive-integer-and-true"},{level:2,title:"Comparing strings",slug:"comparing-strings"},{level:2,title:"Concatenation operator",slug:"concatenation-operator"},{level:2,title:"Reference operators",slug:"reference-operators"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of values",frontmatter:{},regularPath:"/guide/types-of-values.html",relativePath:"guide/types-of-values.md",key:"v-593f2cf6",path:"/guide/types-of-values.html",headers:[{level:2,title:"Date and time values",slug:"date-and-time-values"},{level:2,title:"Getting cell type",slug:"getting-cell-type"},{level:2,title:"Getting cell value type",slug:"getting-cell-value-type"},{level:2,title:"Getting detailed cell value type",slug:"getting-detailed-cell-value-type"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Undo-redo",frontmatter:{},regularPath:"/guide/undo-redo.html",relativePath:"guide/undo-redo.md",key:"v-5f9445a5",path:"/guide/undo-redo.html",headers:[{level:2,title:"isThereSomething* methods",slug:"istheresomething-methods"},{level:2,title:"Batch operations",slug:"batch-operations"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394},{title:"Volatile functions",frontmatter:{},regularPath:"/guide/volatile-functions.html",relativePath:"guide/volatile-functions.md",key:"v-47182957",path:"/guide/volatile-functions.html",headers:[{level:2,title:"Volatile functions",slug:"volatile-functions-2"},{level:2,title:"Volatile actions",slug:"volatile-actions"},{level:2,title:"Tweaking performance",slug:"tweaking-performance"},{level:2,title:"Volatile custom functions",slug:"volatile-custom-functions"}],version:"2.6.0",buildDate:"19/09/2023 11:06:12",releaseDate:"19/09/2023",functionsCount:394}],themeConfig:{logo:"/logo.png",nextLinks:!0,prevLinks:!0,repo:"handsontable/hyperformula",docsRepo:"handsontable/hyperformula",docsDir:"docs",docsBranch:"master",editLinks:!0,editLinkText:"Help us improve this page",lastUpdated:!1,smoothScroll:!1,searchPlaceholder:"Search...",searchLimitApi:10,searchLimitGuide:10,nav:[{text:"Guide",link:"/"},{text:"API Reference",link:"/api/"}],displayAllHeaders:!1,activeHeaderLinks:!0,sidebarDepth:1,sidebar:{"/api/":[{title:"Introduction",path:"/api/"},{title:"HyperFormula Class",path:"/api/classes/hyperformula",collapsable:!0},{title:"Configuration Options",path:"/api/interfaces/configparams",collapsable:!0},{title:"Event Types",path:"/api/interfaces/listeners",alias:"/api/events",collapsable:!0},{title:"Error Types",collapsable:!0,children:[]}],"/":[{title:"Introduction",collapsable:!1,children:[["/","Welcome"],["/guide/demo","Demo"]]},{title:"Overview",collapsable:!1,children:[["/guide/supported-browsers","Supported browsers"],["/guide/dependencies","Dependencies"],["/guide/licensing","Licensing"],["/guide/support","Support"]]},{title:"Getting started",collapsable:!1,children:[["/guide/client-side-installation","Client-side installation"],["/guide/server-side-installation","Server-side installation"],["/guide/basic-usage","Basic usage"],["/guide/advanced-usage","Advanced usage"],["/guide/configuration-options","Configuration options"],["/guide/license-key","License key"]]},{title:"Framework integration",collapsable:!1,children:[["/guide/integration-with-react","Integration with React"],["/guide/integration-with-vue","Integration with Vue"],["/guide/integration-with-angular","Integration with Angular"]]},{title:"Data operations",collapsable:!1,children:[["/guide/basic-operations","Basic operations"],["/guide/batch-operations","Batch operations"],["/guide/clipboard-operations","Clipboard operations"],["/guide/undo-redo","Undo-redo"],["/guide/sorting-data","Sorting data"]]},{title:"Formulas",collapsable:!1,children:[["/guide/specifications-and-limits","Specifications and limits"],["/guide/cell-references","Cell references"],["/guide/types-of-values","Types of values"],["/guide/types-of-errors","Types of errors"],["/guide/types-of-operators","Types of operators"],["/guide/order-of-precendece","Order of precedence"],["/guide/built-in-functions","Built-in functions"],["/guide/volatile-functions","Volatile functions"],["/guide/named-expressions","Named expressions"],["/guide/arrays","Array formulas"]]},{title:"Internationalization",collapsable:!1,children:[["/guide/i18n-features","Internationalization features"],["/guide/localizing-functions","Localizing functions"],["/guide/date-and-time-handling","Date and time handling"]]},{title:"Compatibility",collapsable:!1,children:[["/guide/compatibility-with-microsoft-excel","Compatibility with Microsoft Excel"],["/guide/compatibility-with-google-sheets","Compatibility with Google Sheets"],["/guide/list-of-differences","Runtime differences with Microsoft Excel and Google Sheets"]]},{title:"Advanced topics",collapsable:!1,children:[["/guide/key-concepts","Key concepts"],["/guide/dependency-graph","Dependency graph"],["/guide/building","Building & testing"],["/guide/custom-functions","Custom functions"],["/guide/performance","Performance"],["/guide/known-limitations","Known limitations"],["/guide/file-import","File import"]]},{title:"Upgrade and migration",collapsable:!1,children:[["/guide/release-notes","Release notes"],["/guide/migration-from-0.6-to-1.0","Migrating from 0.6 to 1.0"],["/guide/migration-from-1.0-to-2.0","Migrating from 1.x to 2.0"]]},{title:"Miscellaneous",collapsable:!1,children:[["/guide/contributing","Contributing"],["/guide/code-of-conduct.md","Code of conduct"],["/guide/branding","Branding"],["/guide/contact","Contact"]]}]}}};n(234);qn.component("graph",()=>Promise.all([n.e(0),n.e(14),n.e(20)]).then(n.bind(null,316))),qn.component("Badge",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,317))),qn.component("CodeBlock",()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,312))),qn.component("CodeGroup",()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,313)));n(235);var Al=[({router:e})=>{e.addRoutes([{path:"/guide/",redirect:"/"}])},{},({Vue:e})=>{e.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{}],Tl=[];class Dl extends class{constructor(){this.store=new qn({data:{state:{}}})}$get(e){return this.store.state[e]}$set(e,t){qn.set(this.store.state,e,t)}$emit(...e){this.store.$emit(...e)}$on(...e){this.store.$on(...e)}}{}Object.assign(Dl.prototype,{getPageAsyncComponent:al,getLayoutAsyncComponent:ll,getAsyncComponent:sl,getVueComponent:ul});var Ll={install(e){const t=new Dl;e.$vuepress=t,e.prototype.$vuepress=t}};function Rl(e,t){const n=t.toLowerCase();return e.options.routes.some(e=>e.path.toLowerCase()===n)}var Il={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(e){const t=this.pageKey||this.$parent.$page.key;return fl("pageKey",t),qn.component(t)||qn.component(t,al(t)),qn.component(t)?e(t):e("")}},Fl={functional:!0,props:{slotKey:String,required:!0},render:(e,{props:t,slots:n})=>e("div",{class:["content__"+t.slotKey]},n()[t.slotKey])},Ml={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Nl=(n(236),n(237),Object(Ol.a)(Ml,(function(){var e=this._self._c;return e("span",[e("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[e("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),e("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),e("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),zl={functional:!0,render(e,{parent:t,children:n}){if(t._isMounted)return n;t.$once("hook:mounted",()=>{t.$forceUpdate()})}};qn.config.productionTip=!1,qn.use(Ha),qn.use(Ll),qn.mixin(function(e,t,n=qn){!function(e){e.locales&&Object.keys(e.locales).forEach(t=>{e.locales[t].path=t});Object.freeze(e)}(t),n.$vuepress.$set("siteData",t);const r=new(e(n.$vuepress.$get("siteData"))),i=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),o={};return Object.keys(i).reduce((e,t)=>(t.startsWith("$")&&(e[t]=i[t].get),e),o),{computed:o}}(e=>class{setPage(e){this.__page=e}get $site(){return e}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:e={}}=this.$site;let t,n;for(const r in e)"/"===r?n=e[r]:0===this.$page.path.indexOf(r)&&(t=e[r]);return t||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:e}=this.$page.frontmatter;return"string"==typeof e&&e}get $title(){const e=this.$page,{metaTitle:t}=this.$page.frontmatter;if("string"==typeof t)return t;const n=this.$siteTitle,r=e.frontmatter.home?null:e.frontmatter.title||e.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const e=function(e){if(e){const t=e.filter(e=>"description"===e.name)[0];if(t)return t.content}}(this.$page.frontmatter.meta);return e||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(e,t){for(let n=0;nn||(e.hash?!qn.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(e.hash)}:{x:0,y:0})});!function(e){e.beforeEach((t,n,r)=>{if(Rl(e,t.path))r();else if(/(\/|\.html)$/.test(t.path))if(/\/$/.test(t.path)){const n=t.path.replace(/\/$/,"")+".html";Rl(e,n)?r(n):r()}else r();else{const n=t.path+"/",i=t.path+".html";Rl(e,i)?r(i):Rl(e,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Al.filter(e=>"function"==typeof e).map(t=>t({Vue:qn,options:r,router:n,siteData:jl,isServer:e})))}catch(e){console.error(e)}return{app:new qn(Object.assign(r,{router:n,render:e=>e("div",{attrs:{id:"app"}},[e("RouterView",{ref:"layout"}),e("div",{class:"global-ui"},Tl.map(t=>e(t)))])})),router:n}}(!1).then(({app:e,router:t})=>{t.onReady(()=>{e.$mount("#app")})})}]); \ No newline at end of file +var r=Object.freeze({}),i=Array.isArray;function o(e){return null==e}function a(e){return null!=e}function l(e){return!0===e}function s(e){return"string"==typeof e||"number"==typeof e||"symbol"==typeof e||"boolean"==typeof e}function u(e){return"function"==typeof e}function c(e){return null!==e&&"object"==typeof e}var f=Object.prototype.toString;function d(e){return"[object Object]"===f.call(e)}function p(e){return"[object RegExp]"===f.call(e)}function v(e){var t=parseFloat(String(e));return t>=0&&Math.floor(t)===t&&isFinite(e)}function h(e){return a(e)&&"function"==typeof e.then&&"function"==typeof e.catch}function g(e){return null==e?"":Array.isArray(e)||d(e)&&e.toString===f?JSON.stringify(e,null,2):String(e)}function m(e){var t=parseFloat(e);return isNaN(t)?e:t}function y(e,t){for(var n=Object.create(null),r=e.split(","),i=0;i-1)return e.splice(r,1)}}var x=Object.prototype.hasOwnProperty;function w(e,t){return x.call(e,t)}function C(e){var t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}var S=/-(\w)/g,k=C((function(e){return e.replace(S,(function(e,t){return t?t.toUpperCase():""}))})),P=C((function(e){return e.charAt(0).toUpperCase()+e.slice(1)})),O=/\B([A-Z])/g,E=C((function(e){return e.replace(O,"-$1").toLowerCase()}));var $=Function.prototype.bind?function(e,t){return e.bind(t)}:function(e,t){function n(n){var r=arguments.length;return r?r>1?e.apply(t,arguments):e.call(t,n):e.call(t)}return n._length=e.length,n};function j(e,t){t=t||0;for(var n=e.length-t,r=new Array(n);n--;)r[n]=e[n+t];return r}function A(e,t){for(var n in t)e[n]=t[n];return e}function T(e){for(var t={},n=0;n0,J=Y&&Y.indexOf("edge/")>0;Y&&Y.indexOf("android");var Q=Y&&/iphone|ipad|ipod|ios/.test(Y);Y&&/chrome\/\d+/.test(Y),Y&&/phantomjs/.test(Y);var ee,te=Y&&Y.match(/firefox\/(\d+)/),ne={}.watch,re=!1;if(K)try{var ie={};Object.defineProperty(ie,"passive",{get:function(){re=!0}}),window.addEventListener("test-passive",null,ie)}catch(e){}var oe=function(){return void 0===ee&&(ee=!K&&"undefined"!=typeof global&&(global.process&&"server"===global.process.env.VUE_ENV)),ee},ae=K&&window.__VUE_DEVTOOLS_GLOBAL_HOOK__;function le(e){return"function"==typeof e&&/native code/.test(e.toString())}var se,ue="undefined"!=typeof Symbol&&le(Symbol)&&"undefined"!=typeof Reflect&&le(Reflect.ownKeys);se="undefined"!=typeof Set&&le(Set)?Set:function(){function e(){this.set=Object.create(null)}return e.prototype.has=function(e){return!0===this.set[e]},e.prototype.add=function(e){this.set[e]=!0},e.prototype.clear=function(){this.set=Object.create(null)},e}();var ce=null;function fe(e){void 0===e&&(e=null),e||ce&&ce._scope.off(),ce=e,e&&e._scope.on()}var de=function(){function e(e,t,n,r,i,o,a,l){this.tag=e,this.data=t,this.children=n,this.text=r,this.elm=i,this.ns=void 0,this.context=o,this.fnContext=void 0,this.fnOptions=void 0,this.fnScopeId=void 0,this.key=t&&t.key,this.componentOptions=a,this.componentInstance=void 0,this.parent=void 0,this.raw=!1,this.isStatic=!1,this.isRootInsert=!0,this.isComment=!1,this.isCloned=!1,this.isOnce=!1,this.asyncFactory=l,this.asyncMeta=void 0,this.isAsyncPlaceholder=!1}return Object.defineProperty(e.prototype,"child",{get:function(){return this.componentInstance},enumerable:!1,configurable:!0}),e}(),pe=function(e){void 0===e&&(e="");var t=new de;return t.text=e,t.isComment=!0,t};function ve(e){return new de(void 0,void 0,void 0,String(e))}function he(e){var t=new de(e.tag,e.data,e.children&&e.children.slice(),e.text,e.elm,e.context,e.componentOptions,e.asyncFactory);return t.ns=e.ns,t.isStatic=e.isStatic,t.key=e.key,t.isComment=e.isComment,t.fnContext=e.fnContext,t.fnOptions=e.fnOptions,t.fnScopeId=e.fnScopeId,t.asyncMeta=e.asyncMeta,t.isCloned=!0,t}var ge=0,me=[],ye=function(){function e(){this._pending=!1,this.id=ge++,this.subs=[]}return e.prototype.addSub=function(e){this.subs.push(e)},e.prototype.removeSub=function(e){this.subs[this.subs.indexOf(e)]=null,this._pending||(this._pending=!0,me.push(this))},e.prototype.depend=function(t){e.target&&e.target.addDep(this)},e.prototype.notify=function(e){var t=this.subs.filter((function(e){return e}));for(var n=0,r=t.length;n0&&(Ye((u=e(u,"".concat(n||"","_").concat(r)))[0])&&Ye(f)&&(d[c]=ve(f.text+u[0].text),u.shift()),d.push.apply(d,u)):s(u)?Ye(f)?d[c]=ve(f.text+u):""!==u&&d.push(ve(u)):Ye(u)&&Ye(f)?d[c]=ve(f.text+u.text):(l(t._isVList)&&a(u.tag)&&o(u.key)&&a(n)&&(u.key="__vlist".concat(n,"_").concat(r,"__")),d.push(u)));return d}(e):void 0}function Ye(e){return a(e)&&a(e.text)&&!1===e.isComment}function Xe(e,t){var n,r,o,l,s=null;if(i(e)||"string"==typeof e)for(s=new Array(e.length),n=0,r=e.length;n0,l=t?!!t.$stable:!a,s=t&&t.$key;if(t){if(t._normalized)return t._normalized;if(l&&i&&i!==r&&s===i.$key&&!a&&!i.$hasNormal)return i;for(var u in o={},t)t[u]&&"$"!==u[0]&&(o[u]=ht(e,n,u,t[u]))}else o={};for(var c in n)c in o||(o[c]=gt(n,c));return t&&Object.isExtensible(t)&&(t._normalized=o),W(o,"$stable",l),W(o,"$key",s),W(o,"$hasNormal",a),o}function ht(e,t,n,r){var o=function(){var t=ce;fe(e);var n=arguments.length?r.apply(null,arguments):r({}),o=(n=n&&"object"==typeof n&&!i(n)?[n]:Ke(n))&&n[0];return fe(t),n&&(!o||1===n.length&&o.isComment&&!pt(o))?void 0:n};return r.proxy&&Object.defineProperty(t,n,{get:o,enumerable:!0,configurable:!0}),o}function gt(e,t){return function(){return e[t]}}function mt(e){return{get attrs(){if(!e._attrsProxy){var t=e._attrsProxy={};W(t,"_v_attr_proxy",!0),yt(t,e.$attrs,r,e,"$attrs")}return e._attrsProxy},get listeners(){e._listenersProxy||yt(e._listenersProxy={},e.$listeners,r,e,"$listeners");return e._listenersProxy},get slots(){return function(e){e._slotsProxy||_t(e._slotsProxy={},e.$scopedSlots);return e._slotsProxy}(e)},emit:$(e.$emit,e),expose:function(t){t&&Object.keys(t).forEach((function(n){return Ne(e,t,n)}))}}}function yt(e,t,n,r,i){var o=!1;for(var a in t)a in e?t[a]!==n[a]&&(o=!0):(o=!0,bt(e,a,r,i));for(var a in e)a in t||(o=!0,delete e[a]);return o}function bt(e,t,n,r){Object.defineProperty(e,t,{enumerable:!0,configurable:!0,get:function(){return n[r][t]}})}function _t(e,t){for(var n in t)e[n]=t[n];for(var n in e)n in t||delete e[n]}var xt=null;function wt(e,t){return(e.__esModule||ue&&"Module"===e[Symbol.toStringTag])&&(e=e.default),c(e)?t.extend(e):e}function Ct(e){if(i(e))for(var t=0;tdocument.createEvent("Event").timeStamp&&(sn=function(){return un.now()})}var cn=function(e,t){if(e.post){if(!t.post)return 1}else if(t.post)return-1;return e.id-t.id};function fn(){var e,t;for(ln=sn(),on=!0,en.sort(cn),an=0;anan&&en[n].id>e.id;)n--;en.splice(n+1,0,e)}else en.push(e);rn||(rn=!0,Mt(fn))}}function pn(e,t){if(e){for(var n=Object.create(null),r=ue?Reflect.ownKeys(e):Object.keys(e),i=0;i-1)if(o&&!w(i,"default"))a=!1;else if(""===a||a===E(e)){var s=Rn(String,i.type);(s<0||l-1:"string"==typeof e?e.split(",").indexOf(t)>-1:!!p(e)&&e.test(t)}function Xn(e,t){var n=e.cache,r=e.keys,i=e._vnode;for(var o in n){var a=n[o];if(a){var l=a.name;l&&!t(l)&&Zn(n,o,r,i)}}}function Zn(e,t,n,r){var i=e[t];!i||r&&i.tag===r.tag||i.componentInstance.$destroy(),e[t]=null,_(n,t)}qn.prototype._init=function(e){var t=this;t._uid=Hn++,t._isVue=!0,t.__v_skip=!0,t._scope=new Ue(!0),t._scope._vm=!0,e&&e._isComponent?function(e,t){var n=e.$options=Object.create(e.constructor.options),r=t._parentVnode;n.parent=t.parent,n._parentVnode=r;var i=r.componentOptions;n.propsData=i.propsData,n._parentListeners=i.listeners,n._renderChildren=i.children,n._componentTag=i.tag,t.render&&(n.render=t.render,n.staticRenderFns=t.staticRenderFns)}(t,e):t.$options=$n(Wn(t.constructor),e||{},t),t._renderProxy=t,t._self=t,function(e){var t=e.$options,n=t.parent;if(n&&!t.abstract){for(;n.$options.abstract&&n.$parent;)n=n.$parent;n.$children.push(e)}e.$parent=n,e.$root=n?n.$root:e,e.$children=[],e.$refs={},e._provided=n?n._provided:Object.create(null),e._watcher=null,e._inactive=null,e._directInactive=!1,e._isMounted=!1,e._isDestroyed=!1,e._isBeingDestroyed=!1}(t),function(e){e._events=Object.create(null),e._hasHookEvent=!1;var t=e.$options._parentListeners;t&&Kt(e,t)}(t),function(e){e._vnode=null,e._staticTrees=null;var t=e.$options,n=e.$vnode=t._parentVnode,i=n&&n.context;e.$slots=ft(t._renderChildren,i),e.$scopedSlots=n?vt(e.$parent,n.data.scopedSlots,e.$slots):r,e._c=function(t,n,r,i){return St(e,t,n,r,i,!1)},e.$createElement=function(t,n,r,i){return St(e,t,n,r,i,!0)};var o=n&&n.data;Ae(e,"$attrs",o&&o.attrs||r,null,!0),Ae(e,"$listeners",t._parentListeners||r,null,!0)}(t),Qt(t,"beforeCreate",void 0,!1),function(e){var t=pn(e.$options.inject,e);t&&(Oe(!1),Object.keys(t).forEach((function(n){Ae(e,n,t[n])})),Oe(!0))}(t),Mn(t),function(e){var t=e.$options.provide;if(t){var n=u(t)?t.call(e):t;if(!c(n))return;for(var r=Be(e),i=ue?Reflect.ownKeys(n):Object.keys(n),o=0;o1?j(n):n;for(var r=j(arguments,1),i='event handler for "'.concat(e,'"'),o=0,a=n.length;oparseInt(this.max)&&Zn(e,t[0],t,this._vnode),this.vnodeToCache=null}}},created:function(){this.cache=Object.create(null),this.keys=[]},destroyed:function(){for(var e in this.cache)Zn(this.cache,e,this.keys)},mounted:function(){var e=this;this.cacheVNode(),this.$watch("include",(function(t){Xn(e,(function(e){return Yn(t,e)}))})),this.$watch("exclude",(function(t){Xn(e,(function(e){return!Yn(t,e)}))}))},updated:function(){this.cacheVNode()},render:function(){var e=this.$slots.default,t=Ct(e),n=t&&t.componentOptions;if(n){var r=Kn(n),i=this.include,o=this.exclude;if(i&&(!r||!Yn(i,r))||o&&r&&Yn(o,r))return t;var a=this.cache,l=this.keys,s=null==t.key?n.Ctor.cid+(n.tag?"::".concat(n.tag):""):t.key;a[s]?(t.componentInstance=a[s].componentInstance,_(l,s),l.push(s)):(this.vnodeToCache=t,this.keyToCache=s),t.data.keepAlive=!0}return t||e&&e[0]}}};!function(e){var t={get:function(){return B}};Object.defineProperty(e,"config",t),e.util={warn:wn,extend:A,mergeOptions:$n,defineReactive:Ae},e.set=Te,e.delete=De,e.nextTick=Mt,e.observable=function(e){return je(e),e},e.options=Object.create(null),z.forEach((function(t){e.options[t+"s"]=Object.create(null)})),e.options._base=e,A(e.options.components,Qn),function(e){e.use=function(e){var t=this._installedPlugins||(this._installedPlugins=[]);if(t.indexOf(e)>-1)return this;var n=j(arguments,1);return n.unshift(this),u(e.install)?e.install.apply(e,n):u(e)&&e.apply(null,n),t.push(e),this}}(e),function(e){e.mixin=function(e){return this.options=$n(this.options,e),this}}(e),Gn(e),function(e){z.forEach((function(t){e[t]=function(e,n){return n?("component"===t&&d(n)&&(n.name=n.name||e,n=this.options._base.extend(n)),"directive"===t&&u(n)&&(n={bind:n,update:n}),this.options[t+"s"][e]=n,n):this.options[t+"s"][e]}}))}(e)}(qn),Object.defineProperty(qn.prototype,"$isServer",{get:oe}),Object.defineProperty(qn.prototype,"$ssrContext",{get:function(){return this.$vnode&&this.$vnode.ssrContext}}),Object.defineProperty(qn,"FunctionalRenderContext",{value:vn}),qn.version="2.7.14";var er=y("style,class"),tr=y("input,textarea,option,select,progress"),nr=y("contenteditable,draggable,spellcheck"),rr=y("events,caret,typing,plaintext-only"),ir=y("allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,truespeed,typemustmatch,visible"),or="http://www.w3.org/1999/xlink",ar=function(e){return":"===e.charAt(5)&&"xlink"===e.slice(0,5)},lr=function(e){return ar(e)?e.slice(6,e.length):""},sr=function(e){return null==e||!1===e};function ur(e){for(var t=e.data,n=e,r=e;a(r.componentInstance);)(r=r.componentInstance._vnode)&&r.data&&(t=cr(r.data,t));for(;a(n=n.parent);)n&&n.data&&(t=cr(t,n.data));return function(e,t){if(a(e)||a(t))return fr(e,dr(t));return""}(t.staticClass,t.class)}function cr(e,t){return{staticClass:fr(e.staticClass,t.staticClass),class:a(e.class)?[e.class,t.class]:t.class}}function fr(e,t){return e?t?e+" "+t:e:t||""}function dr(e){return Array.isArray(e)?function(e){for(var t,n="",r=0,i=e.length;r-1?Ir(e,t,n):ir(t)?sr(n)?e.removeAttribute(t):(n="allowfullscreen"===t&&"EMBED"===e.tagName?"true":t,e.setAttribute(t,n)):nr(t)?e.setAttribute(t,function(e,t){return sr(t)||"false"===t?"false":"contenteditable"===e&&rr(t)?t:"true"}(t,n)):ar(t)?sr(n)?e.removeAttributeNS(or,lr(t)):e.setAttributeNS(or,t,n):Ir(e,t,n)}function Ir(e,t,n){if(sr(n))e.removeAttribute(t);else{if(X&&!Z&&"TEXTAREA"===e.tagName&&"placeholder"===t&&""!==n&&!e.__ieph){var r=function(t){t.stopImmediatePropagation(),e.removeEventListener("input",r)};e.addEventListener("input",r),e.__ieph=!0}e.setAttribute(t,n)}}var Fr={create:Lr,update:Lr};function Mr(e,t){var n=t.elm,r=t.data,i=e.data;if(!(o(r.staticClass)&&o(r.class)&&(o(i)||o(i.staticClass)&&o(i.class)))){var l=ur(t),s=n._transitionClasses;a(s)&&(l=fr(l,dr(s))),l!==n._prevClass&&(n.setAttribute("class",l),n._prevClass=l)}}var Nr,zr={create:Mr,update:Mr};function Ur(e,t,n){var r=Nr;return function i(){var o=t.apply(null,arguments);null!==o&&Hr(e,i,n,r)}}var Br=jt&&!(te&&Number(te[1])<=53);function Vr(e,t,n,r){if(Br){var i=ln,o=t;t=o._wrapper=function(e){if(e.target===e.currentTarget||e.timeStamp>=i||e.timeStamp<=0||e.target.ownerDocument!==document)return o.apply(this,arguments)}}Nr.addEventListener(e,t,re?{capture:n,passive:r}:n)}function Hr(e,t,n,r){(r||Nr).removeEventListener(e,t._wrapper||t,n)}function Wr(e,t){if(!o(e.data.on)||!o(t.data.on)){var n=t.data.on||{},r=e.data.on||{};Nr=t.elm||e.elm,function(e){if(a(e.__r)){var t=X?"change":"input";e[t]=[].concat(e.__r,e[t]||[]),delete e.__r}a(e.__c)&&(e.change=[].concat(e.__c,e.change||[]),delete e.__c)}(n),We(n,r,Vr,Hr,Ur,t.context),Nr=void 0}}var qr,Gr={create:Wr,update:Wr,destroy:function(e){return Wr(e,Cr)}};function Kr(e,t){if(!o(e.data.domProps)||!o(t.data.domProps)){var n,r,i=t.elm,s=e.data.domProps||{},u=t.data.domProps||{};for(n in(a(u.__ob__)||l(u._v_attr_proxy))&&(u=t.data.domProps=A({},u)),s)n in u||(i[n]="");for(n in u){if(r=u[n],"textContent"===n||"innerHTML"===n){if(t.children&&(t.children.length=0),r===s[n])continue;1===i.childNodes.length&&i.removeChild(i.childNodes[0])}if("value"===n&&"PROGRESS"!==i.tagName){i._value=r;var c=o(r)?"":String(r);Yr(i,c)&&(i.value=c)}else if("innerHTML"===n&&hr(i.tagName)&&o(i.innerHTML)){(qr=qr||document.createElement("div")).innerHTML="".concat(r,"");for(var f=qr.firstChild;i.firstChild;)i.removeChild(i.firstChild);for(;f.firstChild;)i.appendChild(f.firstChild)}else if(r!==s[n])try{i[n]=r}catch(e){}}}}function Yr(e,t){return!e.composing&&("OPTION"===e.tagName||function(e,t){var n=!0;try{n=document.activeElement!==e}catch(e){}return n&&e.value!==t}(e,t)||function(e,t){var n=e.value,r=e._vModifiers;if(a(r)){if(r.number)return m(n)!==m(t);if(r.trim)return n.trim()!==t.trim()}return n!==t}(e,t))}var Xr={create:Kr,update:Kr},Zr=C((function(e){var t={},n=/:(.+)/;return e.split(/;(?![^(]*\))/g).forEach((function(e){if(e){var r=e.split(n);r.length>1&&(t[r[0].trim()]=r[1].trim())}})),t}));function Jr(e){var t=Qr(e.style);return e.staticStyle?A(e.staticStyle,t):t}function Qr(e){return Array.isArray(e)?T(e):"string"==typeof e?Zr(e):e}var ei,ti=/^--/,ni=/\s*!important$/,ri=function(e,t,n){if(ti.test(t))e.style.setProperty(t,n);else if(ni.test(n))e.style.setProperty(E(t),n.replace(ni,""),"important");else{var r=oi(t);if(Array.isArray(n))for(var i=0,o=n.length;i-1?t.split(si).forEach((function(t){return e.classList.add(t)})):e.classList.add(t);else{var n=" ".concat(e.getAttribute("class")||""," ");n.indexOf(" "+t+" ")<0&&e.setAttribute("class",(n+t).trim())}}function ci(e,t){if(t&&(t=t.trim()))if(e.classList)t.indexOf(" ")>-1?t.split(si).forEach((function(t){return e.classList.remove(t)})):e.classList.remove(t),e.classList.length||e.removeAttribute("class");else{for(var n=" ".concat(e.getAttribute("class")||""," "),r=" "+t+" ";n.indexOf(r)>=0;)n=n.replace(r," ");(n=n.trim())?e.setAttribute("class",n):e.removeAttribute("class")}}function fi(e){if(e){if("object"==typeof e){var t={};return!1!==e.css&&A(t,di(e.name||"v")),A(t,e),t}return"string"==typeof e?di(e):void 0}}var di=C((function(e){return{enterClass:"".concat(e,"-enter"),enterToClass:"".concat(e,"-enter-to"),enterActiveClass:"".concat(e,"-enter-active"),leaveClass:"".concat(e,"-leave"),leaveToClass:"".concat(e,"-leave-to"),leaveActiveClass:"".concat(e,"-leave-active")}})),pi=K&&!Z,vi="transition",hi="transitionend",gi="animation",mi="animationend";pi&&(void 0===window.ontransitionend&&void 0!==window.onwebkittransitionend&&(vi="WebkitTransition",hi="webkitTransitionEnd"),void 0===window.onanimationend&&void 0!==window.onwebkitanimationend&&(gi="WebkitAnimation",mi="webkitAnimationEnd"));var yi=K?window.requestAnimationFrame?window.requestAnimationFrame.bind(window):setTimeout:function(e){return e()};function bi(e){yi((function(){yi(e)}))}function _i(e,t){var n=e._transitionClasses||(e._transitionClasses=[]);n.indexOf(t)<0&&(n.push(t),ui(e,t))}function xi(e,t){e._transitionClasses&&_(e._transitionClasses,t),ci(e,t)}function wi(e,t,n){var r=Si(e,t),i=r.type,o=r.timeout,a=r.propCount;if(!i)return n();var l="transition"===i?hi:mi,s=0,u=function(){e.removeEventListener(l,c),n()},c=function(t){t.target===e&&++s>=a&&u()};setTimeout((function(){s0&&(n="transition",c=a,f=o.length):"animation"===t?u>0&&(n="animation",c=u,f=s.length):f=(n=(c=Math.max(a,u))>0?a>u?"transition":"animation":null)?"transition"===n?o.length:s.length:0,{type:n,timeout:c,propCount:f,hasTransform:"transition"===n&&Ci.test(r[vi+"Property"])}}function ki(e,t){for(;e.length1}function Ai(e,t){!0!==t.data.show&&Oi(t)}var Ti=function(e){var t,n,r={},u=e.modules,c=e.nodeOps;for(t=0;tv?_(e,o(n[m+1])?null:n[m+1].elm,n,p,m,r):p>m&&w(t,f,v)}(f,h,m,n,u):a(m)?(a(e.text)&&c.setTextContent(f,""),_(f,null,m,0,m.length-1,n)):a(h)?w(h,0,h.length-1):a(e.text)&&c.setTextContent(f,""):e.text!==t.text&&c.setTextContent(f,t.text),a(v)&&a(p=v.hook)&&a(p=p.postpatch)&&p(e,t)}}}function P(e,t,n){if(l(n)&&a(e.parent))e.parent.data.pendingInsert=t;else for(var r=0;r-1,a.selected!==o&&(a.selected=o);else if(I(Fi(a),r))return void(e.selectedIndex!==l&&(e.selectedIndex=l));i||(e.selectedIndex=-1)}}function Ii(e,t){return t.every((function(t){return!I(t,e)}))}function Fi(e){return"_value"in e?e._value:e.value}function Mi(e){e.target.composing=!0}function Ni(e){e.target.composing&&(e.target.composing=!1,zi(e.target,"input"))}function zi(e,t){var n=document.createEvent("HTMLEvents");n.initEvent(t,!0,!0),e.dispatchEvent(n)}function Ui(e){return!e.componentInstance||e.data&&e.data.transition?e:Ui(e.componentInstance._vnode)}var Bi={model:Di,show:{bind:function(e,t,n){var r=t.value,i=(n=Ui(n)).data&&n.data.transition,o=e.__vOriginalDisplay="none"===e.style.display?"":e.style.display;r&&i?(n.data.show=!0,Oi(n,(function(){e.style.display=o}))):e.style.display=r?o:"none"},update:function(e,t,n){var r=t.value;!r!=!t.oldValue&&((n=Ui(n)).data&&n.data.transition?(n.data.show=!0,r?Oi(n,(function(){e.style.display=e.__vOriginalDisplay})):Ei(n,(function(){e.style.display="none"}))):e.style.display=r?e.__vOriginalDisplay:"none")},unbind:function(e,t,n,r,i){i||(e.style.display=e.__vOriginalDisplay)}}},Vi={name:String,appear:Boolean,css:Boolean,mode:String,type:String,enterClass:String,leaveClass:String,enterToClass:String,leaveToClass:String,enterActiveClass:String,leaveActiveClass:String,appearClass:String,appearActiveClass:String,appearToClass:String,duration:[Number,String,Object]};function Hi(e){var t=e&&e.componentOptions;return t&&t.Ctor.options.abstract?Hi(Ct(t.children)):e}function Wi(e){var t={},n=e.$options;for(var r in n.propsData)t[r]=e[r];var i=n._parentListeners;for(var r in i)t[k(r)]=i[r];return t}function qi(e,t){if(/\d-keep-alive$/.test(t.tag))return e("keep-alive",{props:t.componentOptions.propsData})}var Gi=function(e){return e.tag||pt(e)},Ki=function(e){return"show"===e.name},Yi={name:"transition",props:Vi,abstract:!0,render:function(e){var t=this,n=this.$slots.default;if(n&&(n=n.filter(Gi)).length){0;var r=this.mode;0;var i=n[0];if(function(e){for(;e=e.parent;)if(e.data.transition)return!0}(this.$vnode))return i;var o=Hi(i);if(!o)return i;if(this._leaving)return qi(e,i);var a="__transition-".concat(this._uid,"-");o.key=null==o.key?o.isComment?a+"comment":a+o.tag:s(o.key)?0===String(o.key).indexOf(a)?o.key:a+o.key:o.key;var l=(o.data||(o.data={})).transition=Wi(this),u=this._vnode,c=Hi(u);if(o.data.directives&&o.data.directives.some(Ki)&&(o.data.show=!0),c&&c.data&&!function(e,t){return t.key===e.key&&t.tag===e.tag}(o,c)&&!pt(c)&&(!c.componentInstance||!c.componentInstance._vnode.isComment)){var f=c.data.transition=A({},l);if("out-in"===r)return this._leaving=!0,qe(f,"afterLeave",(function(){t._leaving=!1,t.$forceUpdate()})),qi(e,i);if("in-out"===r){if(pt(o))return u;var d,p=function(){d()};qe(l,"afterEnter",p),qe(l,"enterCancelled",p),qe(f,"delayLeave",(function(e){d=e}))}}return i}}},Xi=A({tag:String,moveClass:String},Vi);function Zi(e){e.elm._moveCb&&e.elm._moveCb(),e.elm._enterCb&&e.elm._enterCb()}function Ji(e){e.data.newPos=e.elm.getBoundingClientRect()}function Qi(e){var t=e.data.pos,n=e.data.newPos,r=t.left-n.left,i=t.top-n.top;if(r||i){e.data.moved=!0;var o=e.elm.style;o.transform=o.WebkitTransform="translate(".concat(r,"px,").concat(i,"px)"),o.transitionDuration="0s"}}delete Xi.mode;var eo={Transition:Yi,TransitionGroup:{props:Xi,beforeMount:function(){var e=this,t=this._update;this._update=function(n,r){var i=Xt(e);e.__patch__(e._vnode,e.kept,!1,!0),e._vnode=e.kept,i(),t.call(e,n,r)}},render:function(e){for(var t=this.tag||this.$vnode.data.tag||"span",n=Object.create(null),r=this.prevChildren=this.children,i=this.$slots.default||[],o=this.children=[],a=Wi(this),l=0;l-1?mr[e]=t.constructor===window.HTMLUnknownElement||t.constructor===window.HTMLElement:mr[e]=/HTMLUnknownElement/.test(t.toString())},A(qn.options.directives,Bi),A(qn.options.components,eo),qn.prototype.__patch__=K?Ti:D,qn.prototype.$mount=function(e,t){return function(e,t,n){var r;e.$el=t,e.$options.render||(e.$options.render=pe),Qt(e,"beforeMount"),r=function(){e._update(e._render(),n)},new Ht(e,r,D,{before:function(){e._isMounted&&!e._isDestroyed&&Qt(e,"beforeUpdate")}},!0),n=!1;var i=e._preWatchers;if(i)for(var o=0;o=0&&(t=e.slice(r),e=e.slice(0,r));var i=e.indexOf("?");return i>=0&&(n=e.slice(i+1),e=e.slice(0,i)),{path:e,query:n,hash:t}}(i.path||""),u=t&&t.path||"/",c=s.path?wo(s.path,u,n||i.append):u,f=function(e,t,n){void 0===t&&(t={});var r,i=n||so;try{r=i(e||"")}catch(e){r={}}for(var o in t){var a=t[o];r[o]=Array.isArray(a)?a.map(lo):lo(a)}return r}(s.query,i.query,r&&r.options.parseQuery),d=i.hash||s.hash;return d&&"#"!==d.charAt(0)&&(d="#"+d),{_normalized:!0,path:c,query:f,hash:d}}var Vo,Ho=function(){},Wo={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(e){var t=this,n=this.$router,r=this.$route,i=n.resolve(this.to,r,this.append),o=i.location,a=i.route,l=i.href,s={},u=n.options.linkActiveClass,c=n.options.linkExactActiveClass,f=null==u?"router-link-active":u,d=null==c?"router-link-exact-active":c,p=null==this.activeClass?f:this.activeClass,v=null==this.exactActiveClass?d:this.exactActiveClass,h=a.redirectedFrom?fo(null,Bo(a.redirectedFrom),null,n):a;s[v]=mo(r,h,this.exactPath),s[p]=this.exact||this.exactPath?s[v]:function(e,t){return 0===e.path.replace(co,"/").indexOf(t.path.replace(co,"/"))&&(!t.hash||e.hash===t.hash)&&function(e,t){for(var n in t)if(!(n in e))return!1;return!0}(e.query,t.query)}(r,h);var g=s[v]?this.ariaCurrentValue:null,m=function(e){qo(e)&&(t.replace?n.replace(o,Ho):n.push(o,Ho))},y={click:qo};Array.isArray(this.event)?this.event.forEach((function(e){y[e]=m})):y[this.event]=m;var b={class:s},_=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:a,navigate:m,isActive:s[p],isExactActive:s[v]});if(_){if(1===_.length)return _[0];if(_.length>1||!_.length)return 0===_.length?e():e("span",{},_)}if("a"===this.tag)b.on=y,b.attrs={href:l,"aria-current":g};else{var x=function e(t){var n;if(t)for(var r=0;r-1&&(l.params[d]=n.params[d]);return l.path=Uo(c.path,l.params),s(c,l,a)}if(l.path){l.params={};for(var p=0;p-1}function Ca(e,t){return wa(e)&&e._isRouter&&(null==t||e.type===t)}function Sa(e,t,n){var r=function(i){i>=e.length?n():e[i]?t(e[i],(function(){r(i+1)})):r(i+1)};r(0)}function ka(e){return function(t,n,r){var i=!1,o=0,a=null;Pa(e,(function(e,t,n,l){if("function"==typeof e&&void 0===e.cid){i=!0,o++;var s,u=$a((function(t){var i;((i=t).__esModule||Ea&&"Module"===i[Symbol.toStringTag])&&(t=t.default),e.resolved="function"==typeof t?t:Vo.extend(t),n.components[l]=t,--o<=0&&r()})),c=$a((function(e){var t="Failed to resolve async component "+l+": "+e;a||(a=wa(e)?e:new Error(t),r(a))}));try{s=e(u,c)}catch(e){c(e)}if(s)if("function"==typeof s.then)s.then(u,c);else{var f=s.component;f&&"function"==typeof f.then&&f.then(u,c)}}})),i||r()}}function Pa(e,t){return Oa(e.map((function(e){return Object.keys(e.components).map((function(n){return t(e.components[n],e.instances[n],e,n)}))})))}function Oa(e){return Array.prototype.concat.apply([],e)}var Ea="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function $a(e){var t=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!t)return t=!0,e.apply(this,n)}}var ja=function(e,t){this.router=e,this.base=function(e){if(!e)if(Go){var t=document.querySelector("base");e=(e=t&&t.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else e="/";"/"!==e.charAt(0)&&(e="/"+e);return e.replace(/\/$/,"")}(t),this.current=vo,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Aa(e,t,n,r){var i=Pa(e,(function(e,r,i,o){var a=function(e,t){"function"!=typeof e&&(e=Vo.extend(e));return e.options[t]}(e,t);if(a)return Array.isArray(a)?a.map((function(e){return n(e,r,i,o)})):n(a,r,i,o)}));return Oa(r?i.reverse():i)}function Ta(e,t){if(t)return function(){return e.apply(t,arguments)}}ja.prototype.listen=function(e){this.cb=e},ja.prototype.onReady=function(e,t){this.ready?e():(this.readyCbs.push(e),t&&this.readyErrorCbs.push(t))},ja.prototype.onError=function(e){this.errorCbs.push(e)},ja.prototype.transitionTo=function(e,t,n){var r,i=this;try{r=this.router.match(e,this.current)}catch(e){throw this.errorCbs.forEach((function(t){t(e)})),e}var o=this.current;this.confirmTransition(r,(function(){i.updateRoute(r),t&&t(r),i.ensureURL(),i.router.afterHooks.forEach((function(e){e&&e(r,o)})),i.ready||(i.ready=!0,i.readyCbs.forEach((function(e){e(r)})))}),(function(e){n&&n(e),e&&!i.ready&&(Ca(e,ma.redirected)&&o===vo||(i.ready=!0,i.readyErrorCbs.forEach((function(t){t(e)}))))}))},ja.prototype.confirmTransition=function(e,t,n){var r=this,i=this.current;this.pending=e;var o,a,l=function(e){!Ca(e)&&wa(e)&&(r.errorCbs.length?r.errorCbs.forEach((function(t){t(e)})):console.error(e)),n&&n(e)},s=e.matched.length-1,u=i.matched.length-1;if(mo(e,i)&&s===u&&e.matched[s]===i.matched[u])return this.ensureURL(),e.hash&&oa(this.router,i,e,!1),l(((a=_a(o=i,e,ma.duplicated,'Avoided redundant navigation to current location: "'+o.fullPath+'".')).name="NavigationDuplicated",a));var c=function(e,t){var n,r=Math.max(e.length,t.length);for(n=0;n0)){var t=this.router,n=t.options.scrollBehavior,r=va&&n;r&&this.listeners.push(ia());var i=function(){var n=e.current,i=La(e.base);e.current===vo&&i===e._startLocation||e.transitionTo(i,(function(e){r&&oa(t,e,n,!0)}))};window.addEventListener("popstate",i),this.listeners.push((function(){window.removeEventListener("popstate",i)}))}},t.prototype.go=function(e){window.history.go(e)},t.prototype.push=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){ha(Co(r.base+e.fullPath)),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){ga(Co(r.base+e.fullPath)),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.ensureURL=function(e){if(La(this.base)!==this.current.fullPath){var t=Co(this.base+this.current.fullPath);e?ha(t):ga(t)}},t.prototype.getCurrentLocation=function(){return La(this.base)},t}(ja);function La(e){var t=window.location.pathname,n=t.toLowerCase(),r=e.toLowerCase();return!e||n!==r&&0!==n.indexOf(Co(r+"/"))||(t=t.slice(e.length)),(t||"/")+window.location.search+window.location.hash}var Ra=function(e){function t(t,n,r){e.call(this,t,n),r&&function(e){var t=La(e);if(!/^\/#/.test(t))return window.location.replace(Co(e+"/#"+t)),!0}(this.base)||Ia()}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.setupListeners=function(){var e=this;if(!(this.listeners.length>0)){var t=this.router.options.scrollBehavior,n=va&&t;n&&this.listeners.push(ia());var r=function(){var t=e.current;Ia()&&e.transitionTo(Fa(),(function(r){n&&oa(e.router,r,t,!0),va||za(r.fullPath)}))},i=va?"popstate":"hashchange";window.addEventListener(i,r),this.listeners.push((function(){window.removeEventListener(i,r)}))}},t.prototype.push=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){Na(e.fullPath),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,i=this.current;this.transitionTo(e,(function(e){za(e.fullPath),oa(r.router,e,i,!1),t&&t(e)}),n)},t.prototype.go=function(e){window.history.go(e)},t.prototype.ensureURL=function(e){var t=this.current.fullPath;Fa()!==t&&(e?Na(t):za(t))},t.prototype.getCurrentLocation=function(){return Fa()},t}(ja);function Ia(){var e=Fa();return"/"===e.charAt(0)||(za("/"+e),!1)}function Fa(){var e=window.location.href,t=e.indexOf("#");return t<0?"":e=e.slice(t+1)}function Ma(e){var t=window.location.href,n=t.indexOf("#");return(n>=0?t.slice(0,n):t)+"#"+e}function Na(e){va?ha(Ma(e)):window.location.hash=e}function za(e){va?ga(Ma(e)):window.location.replace(Ma(e))}var Ua=function(e){function t(t,n){e.call(this,t,n),this.stack=[],this.index=-1}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.push=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index+1).concat(e),r.index++,t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index).concat(e),t&&t(e)}),n)},t.prototype.go=function(e){var t=this,n=this.index+e;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var e=t.current;t.index=n,t.updateRoute(r),t.router.afterHooks.forEach((function(t){t&&t(r,e)}))}),(function(e){Ca(e,ma.duplicated)&&(t.index=n)}))}},t.prototype.getCurrentLocation=function(){var e=this.stack[this.stack.length-1];return e?e.fullPath:"/"},t.prototype.ensureURL=function(){},t}(ja),Ba=function(e){void 0===e&&(e={}),this.app=null,this.apps=[],this.options=e,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Xo(e.routes||[],this);var t=e.mode||"hash";switch(this.fallback="history"===t&&!va&&!1!==e.fallback,this.fallback&&(t="hash"),Go||(t="abstract"),this.mode=t,t){case"history":this.history=new Da(this,e.base);break;case"hash":this.history=new Ra(this,e.base,this.fallback);break;case"abstract":this.history=new Ua(this,e.base);break;default:0}},Va={currentRoute:{configurable:!0}};Ba.prototype.match=function(e,t,n){return this.matcher.match(e,t,n)},Va.currentRoute.get=function(){return this.history&&this.history.current},Ba.prototype.init=function(e){var t=this;if(this.apps.push(e),e.$once("hook:destroyed",(function(){var n=t.apps.indexOf(e);n>-1&&t.apps.splice(n,1),t.app===e&&(t.app=t.apps[0]||null),t.app||t.history.teardown()})),!this.app){this.app=e;var n=this.history;if(n instanceof Da||n instanceof Ra){var r=function(e){n.setupListeners(),function(e){var r=n.current,i=t.options.scrollBehavior;va&&i&&"fullPath"in e&&oa(t,e,r,!1)}(e)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(e){t.apps.forEach((function(t){t._route=e}))}))}},Ba.prototype.beforeEach=function(e){return Wa(this.beforeHooks,e)},Ba.prototype.beforeResolve=function(e){return Wa(this.resolveHooks,e)},Ba.prototype.afterEach=function(e){return Wa(this.afterHooks,e)},Ba.prototype.onReady=function(e,t){this.history.onReady(e,t)},Ba.prototype.onError=function(e){this.history.onError(e)},Ba.prototype.push=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.push(e,t,n)}));this.history.push(e,t,n)},Ba.prototype.replace=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.replace(e,t,n)}));this.history.replace(e,t,n)},Ba.prototype.go=function(e){this.history.go(e)},Ba.prototype.back=function(){this.go(-1)},Ba.prototype.forward=function(){this.go(1)},Ba.prototype.getMatchedComponents=function(e){var t=e?e.matched?e:this.resolve(e).route:this.currentRoute;return t?[].concat.apply([],t.matched.map((function(e){return Object.keys(e.components).map((function(t){return e.components[t]}))}))):[]},Ba.prototype.resolve=function(e,t,n){var r=Bo(e,t=t||this.history.current,n,this),i=this.match(r,t),o=i.redirectedFrom||i.fullPath;return{location:r,route:i,href:function(e,t,n){var r="hash"===n?"#"+t:t;return e?Co(e+"/"+r):r}(this.history.base,o,this.mode),normalizedTo:r,resolved:i}},Ba.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ba.prototype.addRoute=function(e,t){this.matcher.addRoute(e,t),this.history.current!==vo&&this.history.transitionTo(this.history.getCurrentLocation())},Ba.prototype.addRoutes=function(e){this.matcher.addRoutes(e),this.history.current!==vo&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ba.prototype,Va);var Ha=Ba;function Wa(e,t){return e.push(t),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}Ba.install=function e(t){if(!e.installed||Vo!==t){e.installed=!0,Vo=t;var n=function(e){return void 0!==e},r=function(e,t){var r=e.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(e,t)};t.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),t.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(t.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(t.prototype,"$route",{get:function(){return this._routerRoot._route}}),t.component("RouterView",_o),t.component("RouterLink",Wo);var i=t.config.optionMergeStrategies;i.beforeRouteEnter=i.beforeRouteLeave=i.beforeRouteUpdate=i.created}},Ba.version="3.6.5",Ba.isNavigationFailure=Ca,Ba.NavigationFailureType=ma,Ba.START_LOCATION=vo,Go&&window.Vue&&window.Vue.use(Ba);n(92);n(90),n(100);var qa={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(15)]).then(n.bind(null,311)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(16)]).then(n.bind(null,252)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(22)]).then(n.bind(null,244)),"components/Home":()=>Promise.all([n.e(0),n.e(18)]).then(n.bind(null,287)),"components/NavLink":()=>n.e(24).then(n.bind(null,241)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(13)]).then(n.bind(null,264)),"components/Navbar":()=>Promise.all([n.e(0),n.e(11)]).then(n.bind(null,286)),"components/Page":()=>Promise.all([n.e(0),n.e(12)]).then(n.bind(null,288)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(19)]).then(n.bind(null,266)),"components/PageNav":()=>Promise.all([n.e(0),n.e(17)]).then(n.bind(null,267)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,308)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,269)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,277)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,270)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,268)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,317)),"global-components/CodeBlock":()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,312)),"global-components/CodeGroup":()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,313)),"layouts/404":()=>n.e(8).then(n.bind(null,314)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,315)),NotFound:()=>n.e(8).then(n.bind(null,314)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,315))},Ga={"v-71b8009e":()=>n.e(84).then(n.bind(null,318)),"v-9cdf0f12":()=>n.e(25).then(n.bind(null,319)),"v-1f9f7b20":()=>n.e(26).then(n.bind(null,320)),"v-3a2b96de":()=>n.e(27).then(n.bind(null,321)),"v-621c7425":()=>n.e(28).then(n.bind(null,322)),"v-4b5593a1":()=>n.e(29).then(n.bind(null,323)),"v-fc2ab00a":()=>n.e(30).then(n.bind(null,324)),"v-b6667cf6":()=>n.e(31).then(n.bind(null,325)),"v-4bc9fdb6":()=>n.e(32).then(n.bind(null,326)),"v-c314465a":()=>n.e(33).then(n.bind(null,327)),"v-a3863eb6":()=>n.e(34).then(n.bind(null,328)),"v-e9fe4e82":()=>n.e(35).then(n.bind(null,329)),"v-375f9eb7":()=>n.e(36).then(n.bind(null,330)),"v-aeb8b1d6":()=>n.e(37).then(n.bind(null,331)),"v-412f6645":()=>n.e(38).then(n.bind(null,332)),"v-1cdcf3a6":()=>n.e(39).then(n.bind(null,333)),"v-f988a616":()=>n.e(40).then(n.bind(null,334)),"v-78732dfa":()=>n.e(41).then(n.bind(null,335)),"v-65dbe632":()=>n.e(42).then(n.bind(null,336)),"v-466fcea5":()=>n.e(43).then(n.bind(null,337)),"v-66508ee2":()=>n.e(44).then(n.bind(null,338)),"v-31ee48e5":()=>n.e(45).then(n.bind(null,339)),"v-7e4d1e45":()=>n.e(46).then(n.bind(null,340)),"v-1f1748ef":()=>n.e(47).then(n.bind(null,341)),"v-e77479e2":()=>n.e(48).then(n.bind(null,342)),"v-5402d2a5":()=>n.e(49).then(n.bind(null,343)),"v-3a8b9d05":()=>n.e(50).then(n.bind(null,344)),"v-791a3817":()=>n.e(51).then(n.bind(null,345)),"v-50fb7326":()=>n.e(52).then(n.bind(null,346)),"v-1b398a8b":()=>n.e(53).then(n.bind(null,347)),"v-a5167bb6":()=>n.e(54).then(n.bind(null,348)),"v-8a34b4ce":()=>n.e(55).then(n.bind(null,349)),"v-1e1b965a":()=>n.e(56).then(n.bind(null,350)),"v-7dd309c5":()=>n.e(57).then(n.bind(null,351)),"v-2fbf6376":()=>n.e(58).then(n.bind(null,352)),"v-06488e03":()=>n.e(59).then(n.bind(null,353)),"v-53c0f549":()=>n.e(60).then(n.bind(null,354)),"v-489e573b":()=>n.e(61).then(n.bind(null,355)),"v-829e8b0e":()=>n.e(62).then(n.bind(null,356)),"v-7850e0a5":()=>n.e(63).then(n.bind(null,357)),"v-6cd4b5a5":()=>n.e(64).then(n.bind(null,358)),"v-3e89a305":()=>n.e(65).then(n.bind(null,359)),"v-0f121225":()=>n.e(66).then(n.bind(null,360)),"v-8a28567a":()=>n.e(67).then(n.bind(null,361)),"v-54d712f6":()=>n.e(68).then(n.bind(null,362)),"v-7c6a3045":()=>n.e(69).then(n.bind(null,363)),"v-d90a38b6":()=>n.e(70).then(n.bind(null,364)),"v-26c53da5":()=>n.e(71).then(n.bind(null,365)),"v-3653dd85":()=>n.e(72).then(n.bind(null,366)),"v-7650e1b6":()=>n.e(73).then(n.bind(null,367)),"v-7dcddcc2":()=>n.e(74).then(n.bind(null,368)),"v-2c054345":()=>n.e(75).then(n.bind(null,369)),"v-e6ef97b6":()=>n.e(76).then(n.bind(null,370)),"v-362e1525":()=>n.e(77).then(n.bind(null,371)),"v-5d69bcd2":()=>n.e(78).then(n.bind(null,372)),"v-656b0965":()=>n.e(79).then(n.bind(null,373)),"v-6f197f91":()=>n.e(80).then(n.bind(null,374)),"v-593f2cf6":()=>n.e(81).then(n.bind(null,375)),"v-5f9445a5":()=>n.e(82).then(n.bind(null,376)),"v-47182957":()=>n.e(83).then(n.bind(null,377))};function Ka(e){const t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}const Ya=/-(\w)/g,Xa=Ka(e=>e.replace(Ya,(e,t)=>t?t.toUpperCase():"")),Za=/\B([A-Z])/g,Ja=Ka(e=>e.replace(Za,"-$1").toLowerCase()),Qa=Ka(e=>e.charAt(0).toUpperCase()+e.slice(1));function el(e,t){if(!t)return;if(e(t))return e(t);return t.includes("-")?e(Qa(Xa(t))):e(Qa(t))||e(Ja(t))}const tl=Object.assign({},qa,Ga),nl=e=>tl[e],rl=e=>Ga[e],il=e=>qa[e],ol=e=>qn.component(e);function al(e){return el(rl,e)}function ll(e){return el(il,e)}function sl(e){return el(nl,e)}function ul(e){return el(ol,e)}function cl(...e){return Promise.all(e.filter(e=>e).map(async e=>{if(!ul(e)&&sl(e)){const t=await sl(e)();qn.component(e,t.default)}}))}function fl(e,t){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[e]=t)}var dl=n(87),pl=n.n(dl),vl=n(88),hl=n.n(vl),gl={created(){if(this.siteMeta=this.$site.headTags.filter(([e])=>"meta"===e).map(([e,t])=>t),this.$ssrContext){const t=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(e=t)?e.map(e=>{let t="{t+=` ${n}="${hl()(e[n])}"`}),t+">"}).join("\n "):"",this.$ssrContext.canonicalLink=yl(this.$canonicalUrl)}var e},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const e=this.getMergedMetaTags();this.currentMetaTags=bl(e,this.currentMetaTags)},getMergedMetaTags(){const e=this.$page.frontmatter.meta||[];return pl()([{name:"description",content:this.$description}],e,this.siteMeta,_l)},updateCanonicalLink(){ml(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",yl(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){bl(null,this.currentMetaTags),ml()}};function ml(){const e=document.querySelector("link[rel='canonical']");e&&e.remove()}function yl(e=""){return e?``:""}function bl(e,t){if(t&&[...t].filter(e=>e.parentNode===document.head).forEach(e=>document.head.removeChild(e)),e)return e.map(e=>{const t=document.createElement("meta");return Object.keys(e).forEach(n=>{t.setAttribute(n,e[n])}),document.head.appendChild(t),t})}function _l(e){for(const t of["name","property","itemprop"])if(e.hasOwnProperty(t))return e[t]+t;return JSON.stringify(e)}var xl=n(89),wl={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(xl)()((function(){this.setActiveHash()}),300),setActiveHash(){const e=[].slice.call(document.querySelectorAll(".sidebar-link")),t=[].slice.call(document.querySelectorAll(".header-anchor")).filter(t=>e.some(e=>e.hash===t.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),i=window.innerHeight+n;for(let e=0;e=o.parentElement.offsetTop+10&&(!a||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},Cl=n(22),Sl=n.n(Cl),kl=[gl,wl,{mounted(){Sl.a.configure({showSpinner:!1}),this.$router.beforeEach((e,t,n)=>{e.path===t.path||qn.component(e.name)||Sl.a.start(),n()}),this.$router.afterEach(()=>{Sl.a.done(),this.isSidebarOpen=!1})}}],Pl={name:"GlobalLayout",computed:{layout(){const e=this.getLayout();return fl("layout",e),qn.component(e)}},methods:{getLayout(){if(this.$page.path){const e=this.$page.frontmatter.layout;return e&&(this.$vuepress.getLayoutAsyncComponent(e)||this.$vuepress.getVueComponent(e))?e:"Layout"}return"NotFound"}}},Ol=n(14),El=Object(Ol.a)(Pl,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(e,t,n){switch(t){case"components":e[t]||(e[t]={}),Object.assign(e[t],n);break;case"mixins":e[t]||(e[t]=[]),e[t].push(...n);break;default:throw new Error("Unknown option name.")}}(El,"mixins",kl);const $l=[{name:"v-71b8009e",path:"/",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-71b8009e").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-9cdf0f12",path:"/api-template.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-9cdf0f12").then(n)}},{name:"v-1f9f7b20",path:"/api/",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1f9f7b20").then(n)}},{path:"/api/index.html",redirect:"/api/"},{name:"v-3a2b96de",path:"/api/classes/config.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3a2b96de").then(n)}},{name:"v-621c7425",path:"/api/classes/emitter.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-621c7425").then(n)}},{name:"v-4b5593a1",path:"/api/classes/hyperformula.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-4b5593a1").then(n)}},{name:"v-fc2ab00a",path:"/api/enums/events.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-fc2ab00a").then(n)}},{name:"v-b6667cf6",path:"/api/globals.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-b6667cf6").then(n)}},{name:"v-4bc9fdb6",path:"/api/interfaces/configparams.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-4bc9fdb6").then(n)}},{name:"v-c314465a",path:"/api/interfaces/listeners.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-c314465a").then(n)}},{name:"v-a3863eb6",path:"/api/interfaces/typedemitter.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-a3863eb6").then(n)}},{name:"v-e9fe4e82",path:"/guide/advanced-usage.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e9fe4e82").then(n)}},{name:"v-375f9eb7",path:"/guide/arrays.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-375f9eb7").then(n)}},{name:"v-aeb8b1d6",path:"/guide/basic-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-aeb8b1d6").then(n)}},{name:"v-412f6645",path:"/guide/basic-usage.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-412f6645").then(n)}},{name:"v-1cdcf3a6",path:"/guide/batch-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1cdcf3a6").then(n)}},{name:"v-f988a616",path:"/guide/branding.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-f988a616").then(n)}},{name:"v-78732dfa",path:"/guide/building.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-78732dfa").then(n)}},{name:"v-65dbe632",path:"/guide/built-in-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-65dbe632").then(n)}},{name:"v-466fcea5",path:"/guide/cell-references.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-466fcea5").then(n)}},{name:"v-66508ee2",path:"/guide/client-side-installation.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-66508ee2").then(n)}},{name:"v-31ee48e5",path:"/guide/clipboard-operations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-31ee48e5").then(n)}},{name:"v-7e4d1e45",path:"/guide/code-of-conduct.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7e4d1e45").then(n)}},{name:"v-1f1748ef",path:"/guide/compatibility-with-google-sheets.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1f1748ef").then(n)}},{name:"v-e77479e2",path:"/guide/compatibility-with-microsoft-excel.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e77479e2").then(n)}},{name:"v-5402d2a5",path:"/guide/configuration-options.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5402d2a5").then(n)}},{name:"v-3a8b9d05",path:"/guide/contact.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3a8b9d05").then(n)}},{name:"v-791a3817",path:"/guide/contributing.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-791a3817").then(n)}},{name:"v-50fb7326",path:"/guide/custom-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-50fb7326").then(n)}},{name:"v-1b398a8b",path:"/guide/date-and-time-handling.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1b398a8b").then(n)}},{name:"v-a5167bb6",path:"/guide/demo.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-a5167bb6").then(n)}},{name:"v-8a34b4ce",path:"/guide/dependencies.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-8a34b4ce").then(n)}},{name:"v-1e1b965a",path:"/guide/dependency-graph.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-1e1b965a").then(n)}},{name:"v-7dd309c5",path:"/guide/file-import.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7dd309c5").then(n)}},{name:"v-2fbf6376",path:"/guide/i18n-features.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-2fbf6376").then(n)}},{name:"v-06488e03",path:"/guide/integration-with-angular.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-06488e03").then(n)}},{name:"v-53c0f549",path:"/guide/integration-with-react.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-53c0f549").then(n)}},{name:"v-489e573b",path:"/guide/integration-with-vue.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-489e573b").then(n)}},{name:"v-829e8b0e",path:"/guide/key-concepts.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-829e8b0e").then(n)}},{name:"v-7850e0a5",path:"/guide/known-limitations.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7850e0a5").then(n)}},{name:"v-6cd4b5a5",path:"/guide/license-key.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-6cd4b5a5").then(n)}},{name:"v-3e89a305",path:"/guide/licensing.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3e89a305").then(n)}},{name:"v-0f121225",path:"/guide/list-of-differences.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-0f121225").then(n)}},{name:"v-8a28567a",path:"/guide/localizing-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-8a28567a").then(n)}},{name:"v-54d712f6",path:"/guide/migration-from-0.6-to-1.0.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-54d712f6").then(n)}},{name:"v-7c6a3045",path:"/guide/migration-from-1.0-to-2.0.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7c6a3045").then(n)}},{name:"v-d90a38b6",path:"/guide/named-expressions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-d90a38b6").then(n)}},{name:"v-26c53da5",path:"/guide/order-of-precendece.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-26c53da5").then(n)}},{name:"v-3653dd85",path:"/guide/performance.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-3653dd85").then(n)}},{name:"v-7650e1b6",path:"/guide/release-notes.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7650e1b6").then(n)}},{name:"v-7dcddcc2",path:"/guide/server-side-installation.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-7dcddcc2").then(n)}},{name:"v-2c054345",path:"/guide/sorting-data.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-2c054345").then(n)}},{name:"v-e6ef97b6",path:"/guide/specifications-and-limits.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-e6ef97b6").then(n)}},{name:"v-362e1525",path:"/guide/support.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-362e1525").then(n)}},{name:"v-5d69bcd2",path:"/guide/supported-browsers.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5d69bcd2").then(n)}},{name:"v-656b0965",path:"/guide/types-of-errors.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-656b0965").then(n)}},{name:"v-6f197f91",path:"/guide/types-of-operators.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-6f197f91").then(n)}},{name:"v-593f2cf6",path:"/guide/types-of-values.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-593f2cf6").then(n)}},{name:"v-5f9445a5",path:"/guide/undo-redo.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-5f9445a5").then(n)}},{name:"v-47182957",path:"/guide/volatile-functions.html",component:El,beforeEnter:(e,t,n)=>{cl("Layout","v-47182957").then(n)}},{path:"*",component:El}],jl={title:"HyperFormula (v2.6.0)",description:"HyperFormula is an open-source, high-performance calculation engine for spreadsheets and web applications.",base:"/",headTags:[["script",{},"\n (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\n new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\n j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n })(window,document,'script','dataLayer','GTM-N59TZXR');\n "],["meta",{name:"google-site-verification",content:"MZpSOa8SNvFLRRGwUQpYVZ78kIHQoPVdVbafHhJ_d4Q"}],["link",{rel:"apple-touch-icon",sizes:"180x180",href:"/favicon/apple-touch-icon.png"}],["link",{rel:"icon",sizes:"32x32",type:"image/png",href:"/favicon/favicon-32x32.png"}],["link",{rel:"icon",sizes:"16x16",type:"image/png",href:"/favicon/favicon-16x16.png"}],["link",{rel:"manifest",href:"/favicon/site.webmanifest"}],["link",{rel:"mask-icon",color:"#ffffff",href:"/favicon/safari-pinned-tab.svg"}]],pages:[{title:"HyperFormula guide",frontmatter:{description:"HyperFormula® - Complex Calculations Made Easy"},regularPath:"/",relativePath:"index.md",key:"v-71b8009e",path:"/",headers:[{level:2,title:"What is HyperFormula?",slug:"what-is-hyperformula"},{level:2,title:"What can it be used for?",slug:"what-can-it-be-used-for"},{level:2,title:"Resources",slug:"resources"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{frontmatter:{editLink:!1},regularPath:"/api-template.html",relativePath:"api-template.md",key:"v-9cdf0f12",path:"/api-template.html",headers:[{level:3,title:"API reference index",slug:"api-reference-index"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula API reference",frontmatter:{editLink:!1},regularPath:"/api/",relativePath:"api/README.md",key:"v-1f9f7b20",path:"/api/",headers:[{level:3,title:"API reference index",slug:"api-reference-index"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Config",frontmatter:{editLink:!1},regularPath:"/api/classes/config.html",relativePath:"api/classes/config.md",key:"v-3a2b96de",path:"/api/classes/config.html",headers:[{level:2,title:"Constructors",slug:"constructors"},{level:3,title:"constructor",slug:"constructor"},{level:2,title:"Properties",slug:"properties"},{level:3,title:"accentSensitive",slug:"accentsensitive"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold"},{level:3,title:"caseFirst",slug:"casefirst"},{level:3,title:"caseSensitive",slug:"casesensitive"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy"},{level:3,title:"currencySymbol",slug:"currencysymbol"},{level:3,title:"dateFormats",slug:"dateformats"},{level:3,title:"decimalSeparator",slug:"decimalseparator"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero"},{level:3,title:"functionArgSeparator",slug:"functionargseparator"},{level:3,title:"functionPlugins",slug:"functionplugins"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace"},{level:3,title:"language",slug:"language"},{level:3,title:"leapYear1900",slug:"leapyear1900"},{level:3,title:"licenseKey",slug:"licensekey"},{level:3,title:"localeLang",slug:"localelang"},{level:3,title:"matchWholeCell",slug:"matchwholecell"},{level:3,title:"maxColumns",slug:"maxcolumns"},{level:3,title:"maxRows",slug:"maxrows"},{level:3,title:"nullDate",slug:"nulldate"},{level:3,title:"nullYear",slug:"nullyear"},{level:3,title:"parseDateTime",slug:"parsedatetime"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon"},{level:3,title:"precisionRounding",slug:"precisionrounding"},{level:3,title:"smartRounding",slug:"smartrounding"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime"},{level:3,title:"stringifyDuration",slug:"stringifyduration"},{level:3,title:"thousandSeparator",slug:"thousandseparator"},{level:3,title:"timeFormats",slug:"timeformats"},{level:3,title:"undoLimit",slug:"undolimit"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic"},{level:3,title:"useColumnIndex",slug:"usecolumnindex"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions"},{level:3,title:"useStats",slug:"usestats"},{level:3,title:"useWildcards",slug:"usewildcards"},{level:2,title:"Methods",slug:"methods"},{level:3,title:"getConfig",slug:"getconfig"},{level:3,title:"mergeConfig",slug:"mergeconfig"},{level:2,title:"Object literals",slug:"object-literals"},{level:3,title:"defaultConfig",slug:"defaultconfig"},{level:3,title:"▪ defaultConfig: object",slug:"▪-defaultconfig-object"},{level:3,title:"accentSensitive",slug:"accentsensitive-2"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator-2"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator-2"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold-2"},{level:3,title:"caseFirst",slug:"casefirst-2"},{level:3,title:"caseSensitive",slug:"casesensitive-2"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy-2"},{level:3,title:"currencySymbol",slug:"currencysymbol-2"},{level:3,title:"dateFormats",slug:"dateformats-2"},{level:3,title:"decimalSeparator",slug:"decimalseparator-2"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero-2"},{level:3,title:"functionArgSeparator",slug:"functionargseparator-2"},{level:3,title:"functionPlugins",slug:"functionplugins-2"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation-2"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace-2"},{level:3,title:"language",slug:"language-2"},{level:3,title:"leapYear1900",slug:"leapyear1900-2"},{level:3,title:"licenseKey",slug:"licensekey-2"},{level:3,title:"localeLang",slug:"localelang-2"},{level:3,title:"matchWholeCell",slug:"matchwholecell-2"},{level:3,title:"maxColumns",slug:"maxcolumns-2"},{level:3,title:"maxRows",slug:"maxrows-2"},{level:3,title:"nullYear",slug:"nullyear-2"},{level:3,title:"parseDateTime",slug:"parsedatetime-2"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon-2"},{level:3,title:"precisionRounding",slug:"precisionrounding-2"},{level:3,title:"smartRounding",slug:"smartrounding-2"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime-2"},{level:3,title:"stringifyDuration",slug:"stringifyduration-2"},{level:3,title:"thousandSeparator",slug:"thousandseparator-2"},{level:3,title:"timeFormats",slug:"timeformats-2"},{level:3,title:"undoLimit",slug:"undolimit-2"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic-2"},{level:3,title:"useColumnIndex",slug:"usecolumnindex-2"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions-2"},{level:3,title:"useStats",slug:"usestats-2"},{level:3,title:"useWildcards",slug:"usewildcards-2"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Emitter",frontmatter:{editLink:!1},regularPath:"/api/classes/emitter.html",relativePath:"api/classes/emitter.md",key:"v-621c7425",path:"/api/classes/emitter.html",headers:[{level:2,title:"Methods",slug:"methods"},{level:3,title:"emit",slug:"emit"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula",frontmatter:{editLink:!1},regularPath:"/api/classes/hyperformula.html",relativePath:"api/classes/hyperformula.md",key:"v-4b5593a1",path:"/api/classes/hyperformula.html",headers:[{level:2,title:"Static Properties",slug:"static-properties"},{level:3,title:"buildDate",slug:"builddate"},{level:3,title:"languages",slug:"languages"},{level:3,title:"releaseDate",slug:"releasedate"},{level:3,title:"version",slug:"version"},{level:2,title:"Static Accessors",slug:"static-accessors"},{level:3,title:"defaultConfig",slug:"defaultconfig"},{level:2,title:"Factories",slug:"factories"},{level:3,title:"buildEmpty",slug:"buildempty"},{level:3,title:"buildFromArray",slug:"buildfromarray"},{level:3,title:"buildFromSheets",slug:"buildfromsheets"},{level:2,title:"Instance",slug:"instance"},{level:3,title:"destroy",slug:"destroy"},{level:3,title:"getConfig",slug:"getconfig"},{level:3,title:"rebuildAndRecalculate",slug:"rebuildandrecalculate"},{level:3,title:"updateConfig",slug:"updateconfig"},{level:2,title:"Sheets",slug:"sheets"},{level:3,title:"addSheet",slug:"addsheet"},{level:3,title:"clearSheet",slug:"clearsheet"},{level:3,title:"countSheets",slug:"countsheets"},{level:3,title:"doesSheetExist",slug:"doessheetexist"},{level:3,title:"getAllSheetsDimensions",slug:"getallsheetsdimensions"},{level:3,title:"getAllSheetsFormulas",slug:"getallsheetsformulas"},{level:3,title:"getAllSheetsSerialized",slug:"getallsheetsserialized"},{level:3,title:"getAllSheetsValues",slug:"getallsheetsvalues"},{level:3,title:"getSheetDimensions",slug:"getsheetdimensions"},{level:3,title:"getSheetFormulas",slug:"getsheetformulas"},{level:3,title:"getSheetId",slug:"getsheetid"},{level:3,title:"getSheetName",slug:"getsheetname"},{level:3,title:"getSheetNames",slug:"getsheetnames"},{level:3,title:"getSheetSerialized",slug:"getsheetserialized"},{level:3,title:"getSheetValues",slug:"getsheetvalues"},{level:3,title:"isItPossibleToAddSheet",slug:"isitpossibletoaddsheet"},{level:3,title:"isItPossibleToClearSheet",slug:"isitpossibletoclearsheet"},{level:3,title:"isItPossibleToRemoveSheet",slug:"isitpossibletoremovesheet"},{level:3,title:"isItPossibleToRenameSheet",slug:"isitpossibletorenamesheet"},{level:3,title:"isItPossibleToReplaceSheetContent",slug:"isitpossibletoreplacesheetcontent"},{level:3,title:"removeSheet",slug:"removesheet"},{level:3,title:"renameSheet",slug:"renamesheet"},{level:3,title:"setSheetContent",slug:"setsheetcontent"},{level:2,title:"Ranges",slug:"ranges"},{level:3,title:"getFillRangeData",slug:"getfillrangedata"},{level:3,title:"getRangeFormulas",slug:"getrangeformulas"},{level:3,title:"getRangeSerialized",slug:"getrangeserialized"},{level:3,title:"getRangeValues",slug:"getrangevalues"},{level:2,title:"Rows",slug:"rows"},{level:3,title:"addRows",slug:"addrows"},{level:3,title:"isItPossibleToAddRows",slug:"isitpossibletoaddrows"},{level:3,title:"isItPossibleToMoveRows",slug:"isitpossibletomoverows"},{level:3,title:"isItPossibleToRemoveRows",slug:"isitpossibletoremoverows"},{level:3,title:"isItPossibleToSetRowOrder",slug:"isitpossibletosetroworder"},{level:3,title:"isItPossibleToSwapRowIndexes",slug:"isitpossibletoswaprowindexes"},{level:3,title:"moveRows",slug:"moverows"},{level:3,title:"removeRows",slug:"removerows"},{level:3,title:"setRowOrder",slug:"setroworder"},{level:3,title:"swapRowIndexes",slug:"swaprowindexes"},{level:2,title:"Columns",slug:"columns"},{level:3,title:"addColumns",slug:"addcolumns"},{level:3,title:"isItPossibleToAddColumns",slug:"isitpossibletoaddcolumns"},{level:3,title:"isItPossibleToMoveColumns",slug:"isitpossibletomovecolumns"},{level:3,title:"isItPossibleToRemoveColumns",slug:"isitpossibletoremovecolumns"},{level:3,title:"isItPossibleToSetColumnOrder",slug:"isitpossibletosetcolumnorder"},{level:3,title:"isItPossibleToSwapColumnIndexes",slug:"isitpossibletoswapcolumnindexes"},{level:3,title:"moveColumns",slug:"movecolumns"},{level:3,title:"removeColumns",slug:"removecolumns"},{level:3,title:"setColumnOrder",slug:"setcolumnorder"},{level:3,title:"swapColumnIndexes",slug:"swapcolumnindexes"},{level:2,title:"Cells",slug:"cells"},{level:3,title:"doesCellHaveFormula",slug:"doescellhaveformula"},{level:3,title:"doesCellHaveSimpleValue",slug:"doescellhavesimplevalue"},{level:3,title:"getCellFormula",slug:"getcellformula"},{level:3,title:"getCellHyperlink",slug:"getcellhyperlink"},{level:3,title:"getCellSerialized",slug:"getcellserialized"},{level:3,title:"getCellType",slug:"getcelltype"},{level:3,title:"getCellValue",slug:"getcellvalue"},{level:3,title:"getCellValueDetailedType",slug:"getcellvaluedetailedtype"},{level:3,title:"getCellValueFormat",slug:"getcellvalueformat"},{level:3,title:"getCellValueType",slug:"getcellvaluetype"},{level:3,title:"isCellEmpty",slug:"iscellempty"},{level:3,title:"isCellPartOfArray",slug:"iscellpartofarray"},{level:3,title:"isItPossibleToMoveCells",slug:"isitpossibletomovecells"},{level:3,title:"isItPossibleToSetCellContents",slug:"isitpossibletosetcellcontents"},{level:3,title:"moveCells",slug:"movecells"},{level:3,title:"setCellContents",slug:"setcellcontents"},{level:2,title:"Named Expressions",slug:"named-expressions"},{level:3,title:"addNamedExpression",slug:"addnamedexpression"},{level:3,title:"changeNamedExpression",slug:"changenamedexpression"},{level:3,title:"getAllNamedExpressionsSerialized",slug:"getallnamedexpressionsserialized"},{level:3,title:"getNamedExpression",slug:"getnamedexpression"},{level:3,title:"getNamedExpressionFormula",slug:"getnamedexpressionformula"},{level:3,title:"getNamedExpressionValue",slug:"getnamedexpressionvalue"},{level:3,title:"isItPossibleToAddNamedExpression",slug:"isitpossibletoaddnamedexpression"},{level:3,title:"isItPossibleToChangeNamedExpression",slug:"isitpossibletochangenamedexpression"},{level:3,title:"isItPossibleToRemoveNamedExpression",slug:"isitpossibletoremovenamedexpression"},{level:3,title:"listNamedExpressions",slug:"listnamedexpressions"},{level:3,title:"removeNamedExpression",slug:"removenamedexpression"},{level:2,title:"Helpers",slug:"helpers"},{level:3,title:"calculateFormula",slug:"calculateformula"},{level:3,title:"getCellDependents",slug:"getcelldependents"},{level:3,title:"getCellPrecedents",slug:"getcellprecedents"},{level:3,title:"normalizeFormula",slug:"normalizeformula"},{level:3,title:"numberToDate",slug:"numbertodate"},{level:3,title:"numberToDateTime",slug:"numbertodatetime"},{level:3,title:"numberToTime",slug:"numbertotime"},{level:3,title:"simpleCellAddressFromString",slug:"simplecelladdressfromstring"},{level:3,title:"simpleCellAddressToString",slug:"simplecelladdresstostring"},{level:3,title:"simpleCellRangeFromString",slug:"simplecellrangefromstring"},{level:3,title:"simpleCellRangeToString",slug:"simplecellrangetostring"},{level:3,title:"validateFormula",slug:"validateformula"},{level:2,title:"Clipboard",slug:"clipboard"},{level:3,title:"clearClipboard",slug:"clearclipboard"},{level:3,title:"copy",slug:"copy"},{level:3,title:"cut",slug:"cut"},{level:3,title:"isClipboardEmpty",slug:"isclipboardempty"},{level:3,title:"paste",slug:"paste"},{level:2,title:"Undo and Redo",slug:"undo-and-redo"},{level:3,title:"clearRedoStack",slug:"clearredostack"},{level:3,title:"clearUndoStack",slug:"clearundostack"},{level:3,title:"isThereSomethingToRedo",slug:"istheresomethingtoredo"},{level:3,title:"isThereSomethingToUndo",slug:"istheresomethingtoundo"},{level:3,title:"redo",slug:"redo"},{level:3,title:"undo",slug:"undo"},{level:2,title:"Batch",slug:"batch"},{level:3,title:"batch",slug:"batch-2"},{level:3,title:"isEvaluationSuspended",slug:"isevaluationsuspended"},{level:3,title:"resumeEvaluation",slug:"resumeevaluation"},{level:3,title:"suspendEvaluation",slug:"suspendevaluation"},{level:2,title:"Events",slug:"events"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"},{level:2,title:"Custom Functions",slug:"custom-functions"},{level:3,title:"getAllFunctionPlugins",slug:"getallfunctionplugins"},{level:3,title:"getFunctionPlugin",slug:"getfunctionplugin"},{level:3,title:"getRegisteredFunctionNames",slug:"getregisteredfunctionnames"},{level:2,title:"Static Methods",slug:"static-methods"},{level:3,title:"getAllFunctionPlugins",slug:"getallfunctionplugins-2"},{level:3,title:"getFunctionPlugin",slug:"getfunctionplugin-2"},{level:3,title:"getLanguage",slug:"getlanguage"},{level:3,title:"getRegisteredFunctionNames",slug:"getregisteredfunctionnames-2"},{level:3,title:"getRegisteredLanguagesCodes",slug:"getregisteredlanguagescodes"},{level:3,title:"registerFunction",slug:"registerfunction"},{level:3,title:"registerFunctionPlugin",slug:"registerfunctionplugin"},{level:3,title:"registerLanguage",slug:"registerlanguage"},{level:3,title:"unregisterAllFunctions",slug:"unregisterallfunctions"},{level:3,title:"unregisterFunction",slug:"unregisterfunction"},{level:3,title:"unregisterFunctionPlugin",slug:"unregisterfunctionplugin"},{level:3,title:"unregisterLanguage",slug:"unregisterlanguage"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Events",frontmatter:{editLink:!1},regularPath:"/api/enums/events.html",relativePath:"api/enums/events.md",key:"v-fc2ab00a",path:"/api/enums/events.html",headers:[{level:2,title:"Enumeration members",slug:"enumeration-members"},{level:3,title:"EvaluationResumed",slug:"evaluationresumed"},{level:3,title:"EvaluationSuspended",slug:"evaluationsuspended"},{level:3,title:"NamedExpressionAdded",slug:"namedexpressionadded"},{level:3,title:"NamedExpressionRemoved",slug:"namedexpressionremoved"},{level:3,title:"SheetAdded",slug:"sheetadded"},{level:3,title:"SheetRemoved",slug:"sheetremoved"},{level:3,title:"SheetRenamed",slug:"sheetrenamed"},{level:3,title:"ValuesUpdated",slug:"valuesupdated"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"HyperFormula API reference",frontmatter:{editLink:!1},regularPath:"/api/globals.html",relativePath:"api/globals.md",key:"v-b6667cf6",path:"/api/globals.html",headers:[{level:2,title:"Type aliases",slug:"type-aliases"},{level:3,title:"ConfigParamsList",slug:"configparamslist"},{level:2,title:"Variables",slug:"variables"},{level:3,title:"privatePool",slug:"privatepool"},{level:2,title:"Functions",slug:"functions"},{level:3,title:"getDefaultConfig",slug:"getdefaultconfig"},{level:3,title:"getFullConfigFromPartial",slug:"getfullconfigfrompartial"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"ConfigParams",frontmatter:{editLink:!1},regularPath:"/api/interfaces/configparams.html",relativePath:"api/interfaces/configparams.md",key:"v-4bc9fdb6",path:"/api/interfaces/configparams.html",headers:[{level:2,title:"License",slug:"license"},{level:3,title:"licenseKey",slug:"licensekey"},{level:2,title:"Engine",slug:"engine"},{level:3,title:"binarySearchThreshold",slug:"binarysearchthreshold"},{level:3,title:"chooseAddressMappingPolicy",slug:"chooseaddressmappingpolicy"},{level:3,title:"evaluateNullToZero",slug:"evaluatenulltozero"},{level:3,title:"maxColumns",slug:"maxcolumns"},{level:3,title:"maxRows",slug:"maxrows"},{level:3,title:"useArrayArithmetic",slug:"usearrayarithmetic"},{level:3,title:"useColumnIndex",slug:"usecolumnindex"},{level:3,title:"useStats",slug:"usestats"},{level:2,title:"Formula Syntax",slug:"formula-syntax"},{level:3,title:"arrayColumnSeparator",slug:"arraycolumnseparator"},{level:3,title:"arrayRowSeparator",slug:"arrayrowseparator"},{level:3,title:"functionArgSeparator",slug:"functionargseparator"},{level:3,title:"functionPlugins",slug:"functionplugins"},{level:3,title:"ignoreWhiteSpace",slug:"ignorewhitespace"},{level:3,title:"language",slug:"language"},{level:2,title:"Undo and Redo",slug:"undo-and-redo"},{level:3,title:"undoLimit",slug:"undolimit"},{level:2,title:"Date and Time",slug:"date-and-time"},{level:3,title:"dateFormats",slug:"dateformats"},{level:3,title:"leapYear1900",slug:"leapyear1900"},{level:3,title:"nullDate",slug:"nulldate"},{level:3,title:"nullYear",slug:"nullyear"},{level:3,title:"parseDateTime",slug:"parsedatetime"},{level:3,title:"stringifyDateTime",slug:"stringifydatetime"},{level:3,title:"stringifyDuration",slug:"stringifyduration"},{level:3,title:"timeFormats",slug:"timeformats"},{level:2,title:"Number",slug:"number"},{level:3,title:"currencySymbol",slug:"currencysymbol"},{level:3,title:"decimalSeparator",slug:"decimalseparator"},{level:3,title:"precisionEpsilon",slug:"precisionepsilon"},{level:3,title:"precisionRounding",slug:"precisionrounding"},{level:3,title:"smartRounding",slug:"smartrounding"},{level:3,title:"thousandSeparator",slug:"thousandseparator"},{level:2,title:"String",slug:"string"},{level:3,title:"accentSensitive",slug:"accentsensitive"},{level:3,title:"caseFirst",slug:"casefirst"},{level:3,title:"caseSensitive",slug:"casesensitive"},{level:3,title:"ignorePunctuation",slug:"ignorepunctuation"},{level:3,title:"localeLang",slug:"localelang"},{level:3,title:"matchWholeCell",slug:"matchwholecell"},{level:3,title:"useRegularExpressions",slug:"useregularexpressions"},{level:3,title:"useWildcards",slug:"usewildcards"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Listeners",frontmatter:{editLink:!1},regularPath:"/api/interfaces/listeners.html",relativePath:"api/interfaces/listeners.md",key:"v-c314465a",path:"/api/interfaces/listeners.html",headers:[{level:2,title:"Batch",slug:"batch"},{level:3,title:"evaluationResumed",slug:"evaluationresumed"},{level:3,title:"evaluationSuspended",slug:"evaluationsuspended"},{level:2,title:"Named Expression",slug:"named-expression"},{level:3,title:"namedExpressionAdded",slug:"namedexpressionadded"},{level:3,title:"namedExpressionRemoved",slug:"namedexpressionremoved"},{level:2,title:"Sheet",slug:"sheet"},{level:3,title:"sheetAdded",slug:"sheetadded"},{level:3,title:"sheetRemoved",slug:"sheetremoved"},{level:3,title:"sheetRenamed",slug:"sheetrenamed"},{level:2,title:"Values",slug:"values"},{level:3,title:"valuesUpdated",slug:"valuesupdated"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"TypedEmitter",frontmatter:{editLink:!1},regularPath:"/api/interfaces/typedemitter.html",relativePath:"api/interfaces/typedemitter.md",key:"v-a3863eb6",path:"/api/interfaces/typedemitter.html",headers:[{level:2,title:"Methods",slug:"methods"},{level:3,title:"off",slug:"off"},{level:3,title:"on",slug:"on"},{level:3,title:"once",slug:"once"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Advanced usage",frontmatter:{},regularPath:"/guide/advanced-usage.html",relativePath:"guide/advanced-usage.md",key:"v-e9fe4e82",path:"/guide/advanced-usage.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Array formulas",frontmatter:{},regularPath:"/guide/arrays.html",relativePath:"guide/arrays.md",key:"v-375f9eb7",path:"/guide/arrays.html",headers:[{level:2,title:"About arrays",slug:"about-arrays"},{level:3,title:"Inline arrays",slug:"inline-arrays"},{level:2,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Enabling the array arithmetic mode locally",slug:"enabling-the-array-arithmetic-mode-locally"},{level:3,title:"Enabling the array arithmetic mode globally",slug:"enabling-the-array-arithmetic-mode-globally"},{level:2,title:"Array features",slug:"array-features"},{level:3,title:"Operating on arrays",slug:"operating-on-arrays"},{level:3,title:"Passing arrays to scalar functions (vectorization)",slug:"passing-arrays-to-scalar-functions-vectorization"},{level:3,title:"Broadcasting",slug:"broadcasting"},{level:3,title:"Filtering an array",slug:"filtering-an-array"},{level:3,title:"Constraining an array's size",slug:"constraining-an-array-s-size"},{level:2,title:"Array rules",slug:"array-rules"},{level:3,title:"With the array arithmetic mode enabled",slug:"with-the-array-arithmetic-mode-enabled"},{level:3,title:"With the array arithmetic mode disabled",slug:"with-the-array-arithmetic-mode-disabled"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Basic operations",frontmatter:{},regularPath:"/guide/basic-operations.html",relativePath:"guide/basic-operations.md",key:"v-aeb8b1d6",path:"/guide/basic-operations.html",headers:[{level:2,title:"Sheets",slug:"sheets"},{level:3,title:"Adding a sheet",slug:"adding-a-sheet"},{level:3,title:"Removing a sheet",slug:"removing-a-sheet"},{level:3,title:"Renaming a sheet",slug:"renaming-a-sheet"},{level:3,title:"Clearing a sheet",slug:"clearing-a-sheet"},{level:3,title:"Replacing sheet content",slug:"replacing-sheet-content"},{level:2,title:"Rows",slug:"rows"},{level:3,title:"Adding rows",slug:"adding-rows"},{level:3,title:"Removing rows",slug:"removing-rows"},{level:3,title:"Moving rows",slug:"moving-rows"},{level:3,title:"Reordering rows",slug:"reordering-rows"},{level:2,title:"Columns",slug:"columns"},{level:3,title:"Adding columns",slug:"adding-columns"},{level:3,title:"Removing columns",slug:"removing-columns"},{level:3,title:"Moving columns",slug:"moving-columns"},{level:3,title:"Reordering columns",slug:"reordering-columns"},{level:2,title:"Cells",slug:"cells"},{level:3,title:"Moving cells",slug:"moving-cells"},{level:3,title:"Updating cells",slug:"updating-cells"},{level:3,title:"Getting cell value",slug:"getting-cell-value"},{level:3,title:"Getting cell formula",slug:"getting-cell-formula"},{level:2,title:"Handling an error",slug:"handling-an-error"},{level:2,title:"isItPossibleTo* methods",slug:"isitpossibleto-methods"},{level:2,title:'What are the "changes"?',slug:"what-are-the-changes"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Basic usage",frontmatter:{},regularPath:"/guide/basic-usage.html",relativePath:"guide/basic-usage.md",key:"v-412f6645",path:"/guide/basic-usage.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Batch operations",frontmatter:{},regularPath:"/guide/batch-operations.html",relativePath:"guide/batch-operations.md",key:"v-1cdcf3a6",path:"/guide/batch-operations.html",headers:[{level:2,title:"How to batch",slug:"how-to-batch"},{level:3,title:"Using the batch method",slug:"using-the-batch-method"},{level:3,title:"Using the suspendEvaluation and resumeEvaluation methods",slug:"using-the-suspendevaluation-and-resumeevaluation-methods"},{level:3,title:"Adjusting need with the isEvaluationSuspended method",slug:"adjusting-need-with-the-isevaluationsuspended-method"},{level:2,title:"When to batch",slug:"when-to-batch"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Branding",frontmatter:{},regularPath:"/guide/branding.html",relativePath:"guide/branding.md",key:"v-f988a616",path:"/guide/branding.html",headers:[{level:2,title:"Our logo",slug:"our-logo"},{level:2,title:"Logotype",slug:"logotype"},{level:2,title:"Resources",slug:"resources"},{level:2,title:"Terms of use",slug:"terms-of-use"},{level:2,title:"Trademark protection",slug:"trademark-protection"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Building",frontmatter:{},regularPath:"/guide/building.html",relativePath:"guide/building.md",key:"v-78732dfa",path:"/guide/building.html",headers:[{level:2,title:"Build the project",slug:"build-the-project"},{level:2,title:"Verify the build",slug:"verify-the-build"},{level:2,title:"Build the documentation",slug:"build-the-documentation"},{level:2,title:"Run the tests",slug:"run-the-tests"},{level:2,title:"Run the linter",slug:"run-the-linter"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Built-in functions",frontmatter:{},regularPath:"/guide/built-in-functions.html",relativePath:"guide/built-in-functions.md",key:"v-65dbe632",path:"/guide/built-in-functions.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"List of available functions",slug:"list-of-available-functions"},{level:3,title:"Array manipulation",slug:"array-manipulation"},{level:3,title:"Date and time",slug:"date-and-time"},{level:3,title:"Engineering",slug:"engineering"},{level:3,title:"Information",slug:"information"},{level:3,title:"Financial",slug:"financial"},{level:3,title:"Logical",slug:"logical"},{level:3,title:"Lookup and reference",slug:"lookup-and-reference"},{level:3,title:"Math and trigonometry",slug:"math-and-trigonometry"},{level:3,title:"Matrix functions",slug:"matrix-functions"},{level:3,title:"Operator",slug:"operator"},{level:3,title:"Statistical",slug:"statistical"},{level:3,title:"Text",slug:"text"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Cell references",frontmatter:{},regularPath:"/guide/cell-references.html",relativePath:"guide/cell-references.md",key:"v-466fcea5",path:"/guide/cell-references.html",headers:[{level:3,title:"Referring to named expressions",slug:"referring-to-named-expressions"},{level:2,title:"Relative references",slug:"relative-references"},{level:2,title:"Absolute references",slug:"absolute-references"},{level:2,title:"Range references",slug:"range-references"},{level:3,title:"Range definition",slug:"range-definition"},{level:3,title:"Range types",slug:"range-types"},{level:3,title:"Referencing ranges",slug:"referencing-ranges"},{level:3,title:"Range restraints",slug:"range-restraints"},{level:3,title:"More about ranges",slug:"more-about-ranges"},{level:2,title:"Circular references",slug:"circular-references"},{level:2,title:"The #REF! error",slug:"the-ref-error"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Client-side installation",frontmatter:{},regularPath:"/guide/client-side-installation.html",relativePath:"guide/client-side-installation.md",key:"v-66508ee2",path:"/guide/client-side-installation.html",headers:[{level:3,title:"Install with npm or Yarn",slug:"install-with-npm-or-yarn"},{level:2,title:"Use CDN",slug:"use-cdn"},{level:2,title:"Clone from GitHub",slug:"clone-from-github"},{level:3,title:"Clone with HTTPS",slug:"clone-with-https"},{level:3,title:"Clone with SSH",slug:"clone-with-ssh"},{level:2,title:"Download from GitHub",slug:"download-from-github"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Clipboard operations",frontmatter:{},regularPath:"/guide/clipboard-operations.html",relativePath:"guide/clipboard-operations.md",key:"v-31ee48e5",path:"/guide/clipboard-operations.html",headers:[{level:2,title:"Copy",slug:"copy"},{level:2,title:"Cut",slug:"cut"},{level:2,title:"Paste",slug:"paste"},{level:3,title:"Copy and paste",slug:"copy-and-paste"},{level:3,title:"Cut and paste",slug:"cut-and-paste"},{level:2,title:"Clear the clipboard",slug:"clear-the-clipboard"},{level:2,title:"Data storage",slug:"data-storage"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Code of conduct",frontmatter:{},regularPath:"/guide/code-of-conduct.html",relativePath:"guide/code-of-conduct.md",key:"v-7e4d1e45",path:"/guide/code-of-conduct.html",headers:[{level:2,title:"Our Pledge",slug:"our-pledge"},{level:2,title:"Our Standards",slug:"our-standards"},{level:2,title:"Enforcement Responsibilities",slug:"enforcement-responsibilities"},{level:2,title:"Scope",slug:"scope"},{level:2,title:"Enforcement",slug:"enforcement"},{level:2,title:"Enforcement Guidelines",slug:"enforcement-guidelines"},{level:3,title:"1. Correction",slug:"_1-correction"},{level:3,title:"2. Warning",slug:"_2-warning"},{level:3,title:"3. Temporary Ban",slug:"_3-temporary-ban"},{level:3,title:"4. Permanent Ban",slug:"_4-permanent-ban"},{level:2,title:"Attribution",slug:"attribution"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Compatibility with Google Sheets",frontmatter:{},regularPath:"/guide/compatibility-with-google-sheets.html",relativePath:"guide/compatibility-with-google-sheets.md",key:"v-1f1748ef",path:"/guide/compatibility-with-google-sheets.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Configure compatibility with Google Sheets",slug:"configure-compatibility-with-google-sheets"},{level:3,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Leap year bug",slug:"leap-year-bug"},{level:3,title:"Numerical precision",slug:"numerical-precision"},{level:3,title:"Separators",slug:"separators"},{level:3,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Full configuration",slug:"full-configuration"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Compatibility with Microsoft Excel",frontmatter:{},regularPath:"/guide/compatibility-with-microsoft-excel.html",relativePath:"guide/compatibility-with-microsoft-excel.md",key:"v-e77479e2",path:"/guide/compatibility-with-microsoft-excel.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Configure compatibility with Microsoft Excel",slug:"configure-compatibility-with-microsoft-excel"},{level:3,title:"String comparison rules",slug:"string-comparison-rules"},{level:3,title:"Function criteria",slug:"function-criteria"},{level:3,title:"TRUE and FALSE constants",slug:"true-and-false-constants"},{level:3,title:"Array arithmetic mode",slug:"array-arithmetic-mode"},{level:3,title:"Whitespace in formulas",slug:"whitespace-in-formulas"},{level:3,title:"Formulas that evaluate to null",slug:"formulas-that-evaluate-to-null"},{level:3,title:"Leap year bug",slug:"leap-year-bug"},{level:3,title:"Numerical precision",slug:"numerical-precision"},{level:3,title:"Separators",slug:"separators"},{level:3,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Full configuration",slug:"full-configuration"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Configuration options",frontmatter:{},regularPath:"/guide/configuration-options.html",relativePath:"guide/configuration-options.md",key:"v-5402d2a5",path:"/guide/configuration-options.html",headers:[{level:2,title:"Example",slug:"example"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Contact",frontmatter:{},regularPath:"/guide/contact.html",relativePath:"guide/contact.md",key:"v-3a8b9d05",path:"/guide/contact.html",headers:[{level:2,title:"Contact sales",slug:"contact-sales"},{level:2,title:"Billing address",slug:"billing-address"},{level:2,title:"Looking for technical support?",slug:"looking-for-technical-support"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Contributing",frontmatter:{},regularPath:"/guide/contributing.html",relativePath:"guide/contributing.md",key:"v-791a3817",path:"/guide/contributing.html",headers:[{level:2,title:"Good first issue",slug:"good-first-issue"},{level:2,title:"How to get started",slug:"how-to-get-started"},{level:2,title:"Code of conduct",slug:"code-of-conduct"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Custom functions",frontmatter:{},regularPath:"/guide/custom-functions.html",relativePath:"guide/custom-functions.md",key:"v-50fb7326",path:"/guide/custom-functions.html",headers:[{level:2,title:"Add a simple custom function",slug:"add-a-simple-custom-function"},{level:3,title:"1. Create a function plugin",slug:"_1-create-a-function-plugin"},{level:3,title:"2. Define your function's ID, method, and metadata",slug:"_2-define-your-function-s-id-method-and-metadata"},{level:3,title:"3. Add your function's names",slug:"_3-add-your-function-s-names"},{level:3,title:"4. Implement your function's logic",slug:"_4-implement-your-function-s-logic"},{level:3,title:"5. Register your function plugin",slug:"_5-register-your-function-plugin"},{level:3,title:"6. Use your custom function in a formula",slug:"_6-use-your-custom-function-in-a-formula"},{level:3,title:"Full example",slug:"full-example"},{level:2,title:"Advanced custom function example",slug:"advanced-custom-function-example"},{level:3,title:"Accept a range argument",slug:"accept-a-range-argument"},{level:3,title:"Return an array of data",slug:"return-an-array-of-data"},{level:3,title:"Validate the arguments and return an error",slug:"validate-the-arguments-and-return-an-error"},{level:3,title:"Test your function",slug:"test-your-function"},{level:2,title:"Working demo",slug:"working-demo"},{level:2,title:"Function options",slug:"function-options"},{level:3,title:"Argument validation options",slug:"argument-validation-options"},{level:3,title:"Types of the function argument",slug:"types-of-the-function-argument"},{level:3,title:"Handling missing arguments",slug:"handling-missing-arguments"},{level:2,title:"Function name translations",slug:"function-name-translations"},{level:2,title:"Function aliases",slug:"function-aliases"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Date and time handling",frontmatter:{},regularPath:"/guide/date-and-time-handling.html",relativePath:"guide/date-and-time-handling.md",key:"v-1b398a8b",path:"/guide/date-and-time-handling.html",headers:[{level:2,title:"Example",slug:"example"},{level:2,title:"Custom date and time handling",slug:"custom-date-and-time-handling"},{level:2,title:"Moment.js integration",slug:"moment-js-integration"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Demo",frontmatter:{},regularPath:"/guide/demo.html",relativePath:"guide/demo.md",key:"v-a5167bb6",path:"/guide/demo.html",version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Dependencies",frontmatter:{},regularPath:"/guide/dependencies.html",relativePath:"guide/dependencies.md",key:"v-8a34b4ce",path:"/guide/dependencies.html",version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Dependency graph",frontmatter:{},regularPath:"/guide/dependency-graph.html",relativePath:"guide/dependency-graph.md",key:"v-1e1b965a",path:"/guide/dependency-graph.html",headers:[{level:2,title:"Cells in the dependency graph",slug:"cells-in-the-dependency-graph"},{level:2,title:"Ranges in the dependency graph",slug:"ranges-in-the-dependency-graph"},{level:3,title:"Optimizations for large ranges",slug:"optimizations-for-large-ranges"},{level:2,title:"Getting the immediate precedents of a cell or a range",slug:"getting-the-immediate-precedents-of-a-cell-or-a-range"},{level:2,title:"Getting the immediate dependents of a cell or a range",slug:"getting-the-immediate-dependents-of-a-cell-or-a-range"},{level:2,title:"Getting all precedents of a cell or a range",slug:"getting-all-precedents-of-a-cell-or-a-range"},{level:2,title:"Getting all dependents of a cell or a range",slug:"getting-all-dependents-of-a-cell-or-a-range"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"File import",frontmatter:{},regularPath:"/guide/file-import.html",relativePath:"guide/file-import.md",key:"v-7dd309c5",path:"/guide/file-import.html",headers:[{level:2,title:"Overview",slug:"overview"},{level:2,title:"Import CSV files",slug:"import-csv-files"},{level:2,title:"Import XLSX files",slug:"import-xlsx-files"},{level:3,title:"Example: Import XLSX files in Node",slug:"example-import-xlsx-files-in-node"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Internationalization features",frontmatter:{},regularPath:"/guide/i18n-features.html",relativePath:"guide/i18n-features.md",key:"v-2fbf6376",path:"/guide/i18n-features.html",headers:[{level:2,title:"Function names and errors",slug:"function-names-and-errors"},{level:2,title:"Date and time formats",slug:"date-and-time-formats"},{level:2,title:"Number format",slug:"number-format"},{level:2,title:"Currency symbol",slug:"currency-symbol"},{level:2,title:"String comparison rules",slug:"string-comparison-rules"},{level:2,title:"Compatibility with other spreadsheet software",slug:"compatibility-with-other-spreadsheet-software"},{level:2,title:"en-US configuration",slug:"en-us-configuration"},{level:2,title:"en-US demo",slug:"en-us-demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with Angular",frontmatter:{},regularPath:"/guide/integration-with-angular.html",relativePath:"guide/integration-with-angular.md",key:"v-06488e03",path:"/guide/integration-with-angular.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with React",frontmatter:{},regularPath:"/guide/integration-with-react.html",relativePath:"guide/integration-with-react.md",key:"v-53c0f549",path:"/guide/integration-with-react.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Integration with Vue",frontmatter:{},regularPath:"/guide/integration-with-vue.html",relativePath:"guide/integration-with-vue.md",key:"v-489e573b",path:"/guide/integration-with-vue.html",headers:[{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Key concepts",frontmatter:{},regularPath:"/guide/key-concepts.html",relativePath:"guide/key-concepts.md",key:"v-829e8b0e",path:"/guide/key-concepts.html",headers:[{level:2,title:"High-level design diagram",slug:"high-level-design-diagram"},{level:2,title:"Phase 1. Parsing and construction of ASTs",slug:"phase-1-parsing-and-construction-of-asts"},{level:2,title:"Phase 2. Construction of the dependency graph",slug:"phase-2-construction-of-the-dependency-graph"},{level:2,title:"Phase 3. Evaluation",slug:"phase-3-evaluation"},{level:2,title:"Grammar",slug:"grammar"},{level:2,title:"Repetitive ASTs",slug:"repetitive-asts"},{level:2,title:"Relative addressing",slug:"relative-addressing"},{level:2,title:"Laziness of CRUD operations",slug:"laziness-of-crud-operations"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Known limitations",frontmatter:{},regularPath:"/guide/known-limitations.html",relativePath:"guide/known-limitations.md",key:"v-7850e0a5",path:"/guide/known-limitations.html",headers:[{level:2,title:"Nuances of the implemented functions",slug:"nuances-of-the-implemented-functions"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"License key",frontmatter:{},regularPath:"/guide/license-key.html",relativePath:"guide/license-key.md",key:"v-6cd4b5a5",path:"/guide/license-key.html",headers:[{level:2,title:"GPLv3 license",slug:"gplv3-license"},{level:2,title:"Commercial license",slug:"commercial-license"},{level:3,title:"Commercial license key validation",slug:"commercial-license-key-validation"},{level:2,title:"License key notifications",slug:"license-key-notifications"},{level:2,title:"License key support",slug:"license-key-support"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Licensing",frontmatter:{},regularPath:"/guide/licensing.html",relativePath:"guide/licensing.md",key:"v-3e89a305",path:"/guide/licensing.html",headers:[{level:2,title:"Available licenses",slug:"available-licenses"},{level:2,title:"Non-commercial and open-source use",slug:"non-commercial-and-open-source-use"},{level:2,title:"Commercial use",slug:"commercial-use"},{level:2,title:"Entering a license key",slug:"entering-a-license-key"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"List of differences with other spreadsheets",frontmatter:{},regularPath:"/guide/list-of-differences.html",relativePath:"guide/list-of-differences.md",key:"v-0f121225",path:"/guide/list-of-differences.html",headers:[{level:2,title:"General functionalities",slug:"general-functionalities"},{level:2,title:"Built-in functions",slug:"built-in-functions"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Localizing functions",frontmatter:{},regularPath:"/guide/localizing-functions.html",relativePath:"guide/localizing-functions.md",key:"v-8a28567a",path:"/guide/localizing-functions.html",headers:[{level:2,title:"Localizing custom functions",slug:"localizing-custom-functions"},{level:3,title:"List of supported languages",slug:"list-of-supported-languages"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Migrating from 0.6 to 1.0",frontmatter:{},regularPath:"/guide/migration-from-0.6-to-1.0.html",relativePath:"guide/migration-from-0.6-to-1.0.md",key:"v-54d712f6",path:"/guide/migration-from-0.6-to-1.0.html",headers:[{level:2,title:"Step 1: Change your license key",slug:"step-1-change-your-license-key"},{level:3,title:"Open-source license",slug:"open-source-license"},{level:3,title:"Free non-commercial license",slug:"free-non-commercial-license"},{level:2,title:"Step 2: Change sheetName to sheetId",slug:"step-2-change-sheetname-to-sheetid"},{level:2,title:"Step 3: Adapt to the matrix->array name changes",slug:"step-3-adapt-to-the-matrix-array-name-changes"},{level:3,title:"Configuration option names",slug:"configuration-option-names"},{level:3,title:"API method names",slug:"api-method-names"},{level:3,title:"Exception names",slug:"exception-names"},{level:2,title:"Step 4: Drop the matrix formula notation",slug:"step-4-drop-the-matrix-formula-notation"},{level:2,title:"Step 5: Drop the matrixDetection and matrixDetectionThreshold options",slug:"step-5-drop-the-matrixdetection-and-matrixdetectionthreshold-options"},{level:2,title:"Step 6: Switch to the SimpleCellRange type argument",slug:"step-6-switch-to-the-simplecellrange-type-argument"},{level:2,title:"Step 7: Adapt to the array changes",slug:"step-7-adapt-to-the-array-changes"},{level:3,title:"setCellContents()",slug:"setcellcontents"},{level:3,title:"addRows() and removeRows()",slug:"addrows-and-removerows"},{level:3,title:"addColumns() and removeColumns()",slug:"addcolumns-and-removecolumns"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Migrating from 1.x to 2.0",frontmatter:{},regularPath:"/guide/migration-from-1.0-to-2.0.html",relativePath:"guide/migration-from-1.0-to-2.0.md",key:"v-7c6a3045",path:"/guide/migration-from-1.0-to-2.0.html",headers:[{level:2,title:"Drop the gpujs and gpuMode options",slug:"drop-the-gpujs-and-gpumode-options"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Named expressions",frontmatter:{},regularPath:"/guide/named-expressions.html",relativePath:"guide/named-expressions.md",key:"v-d90a38b6",path:"/guide/named-expressions.html",headers:[{level:2,title:"Examples",slug:"examples"},{level:2,title:"Naming rules",slug:"naming-rules"},{level:2,title:"Available methods",slug:"available-methods"},{level:3,title:"Adding a named expression",slug:"adding-a-named-expression"},{level:3,title:"Changing a named expression",slug:"changing-a-named-expression"},{level:3,title:"Removing a named expression",slug:"removing-a-named-expression"},{level:3,title:"Listing all named expressions",slug:"listing-all-named-expressions"},{level:2,title:"Handling errors",slug:"handling-errors"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Order of precedence",frontmatter:{},regularPath:"/guide/order-of-precendece.html",relativePath:"guide/order-of-precendece.md",key:"v-26c53da5",path:"/guide/order-of-precendece.html",headers:[{level:2,title:"Table of precedence",slug:"table-of-precedence"},{level:2,title:"Using parentheses",slug:"using-parentheses"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Performance",frontmatter:{},regularPath:"/guide/performance.html",relativePath:"guide/performance.md",key:"v-3653dd85",path:"/guide/performance.html",headers:[{level:2,title:"VLOOKUP/MATCH",slug:"vlookup-match"},{level:2,title:"Address mapping strategies",slug:"address-mapping-strategies"},{level:2,title:"Suspending automatic recalculations",slug:"suspending-automatic-recalculations"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Release notes",frontmatter:{},regularPath:"/guide/release-notes.html",relativePath:"guide/release-notes.md",key:"v-7650e1b6",path:"/guide/release-notes.html",headers:[{level:2,title:"2.6.0",slug:"_2-6-0"},{level:3,title:"Added",slug:"added"},{level:3,title:"Changed",slug:"changed"},{level:3,title:"Fixed",slug:"fixed"},{level:2,title:"2.5.0",slug:"_2-5-0"},{level:3,title:"Added",slug:"added-2"},{level:3,title:"Changed",slug:"changed-2"},{level:3,title:"Fixed",slug:"fixed-2"},{level:2,title:"2.4.0",slug:"_2-4-0"},{level:3,title:"Added",slug:"added-3"},{level:3,title:"Fixed",slug:"fixed-3"},{level:2,title:"2.3.1",slug:"_2-3-1"},{level:3,title:"Fixed",slug:"fixed-4"},{level:2,title:"2.3.0",slug:"_2-3-0"},{level:3,title:"Added",slug:"added-4"},{level:2,title:"2.2.0",slug:"_2-2-0"},{level:3,title:"Added",slug:"added-5"},{level:3,title:"Fixed",slug:"fixed-5"},{level:2,title:"2.1.0",slug:"_2-1-0"},{level:3,title:"Added",slug:"added-6"},{level:3,title:"Changed",slug:"changed-3"},{level:3,title:"Fixed",slug:"fixed-6"},{level:3,title:"Removed",slug:"removed"},{level:2,title:"2.0.1",slug:"_2-0-1"},{level:3,title:"Changed",slug:"changed-4"},{level:3,title:"Fixed",slug:"fixed-7"},{level:2,title:"2.0.0",slug:"_2-0-0"},{level:3,title:"Added",slug:"added-7"},{level:3,title:"Changed",slug:"changed-5"},{level:3,title:"Fixed",slug:"fixed-8"},{level:2,title:"1.3.1",slug:"_1-3-1"},{level:3,title:"Fixed",slug:"fixed-9"},{level:2,title:"1.3.0",slug:"_1-3-0"},{level:3,title:"Added",slug:"added-8"},{level:3,title:"Fixed",slug:"fixed-10"},{level:2,title:"1.2.0",slug:"_1-2-0"},{level:3,title:"Changed",slug:"changed-6"},{level:2,title:"1.1.0",slug:"_1-1-0"},{level:3,title:"Added",slug:"added-9"},{level:3,title:"Changed",slug:"changed-7"},{level:3,title:"Fixed",slug:"fixed-11"},{level:2,title:"1.0.0",slug:"_1-0-0"},{level:3,title:"Added",slug:"added-10"},{level:3,title:"Changed",slug:"changed-8"},{level:3,title:"Fixed",slug:"fixed-12"},{level:2,title:"0.6.2",slug:"_0-6-2"},{level:3,title:"Changed",slug:"changed-9"},{level:2,title:"0.6.1",slug:"_0-6-1"},{level:3,title:"Changed",slug:"changed-10"},{level:3,title:"Fixed",slug:"fixed-13"},{level:2,title:"0.6.0",slug:"_0-6-0"},{level:3,title:"Added",slug:"added-11"},{level:3,title:"Changed",slug:"changed-11"},{level:3,title:"Fixed",slug:"fixed-14"},{level:2,title:"0.5.0",slug:"_0-5-0"},{level:3,title:"Added",slug:"added-12"},{level:3,title:"Changed",slug:"changed-12"},{level:3,title:"Fixed",slug:"fixed-15"},{level:2,title:"0.4.0",slug:"_0-4-0"},{level:3,title:"Added",slug:"added-13"},{level:3,title:"Changed",slug:"changed-13"},{level:3,title:"Fixed",slug:"fixed-16"},{level:2,title:"0.3.0",slug:"_0-3-0"},{level:3,title:"Added",slug:"added-14"},{level:3,title:"Fixed",slug:"fixed-17"},{level:2,title:"0.2.0",slug:"_0-2-0"},{level:3,title:"Added",slug:"added-15"},{level:3,title:"Changed",slug:"changed-14"},{level:3,title:"Fixed",slug:"fixed-18"},{level:2,title:"0.1.3",slug:"_0-1-3"},{level:3,title:"Fixed",slug:"fixed-19"},{level:2,title:"0.1.2",slug:"_0-1-2"},{level:3,title:"Fixed",slug:"fixed-20"},{level:2,title:"0.1.1",slug:"_0-1-1"},{level:3,title:"Fixed",slug:"fixed-21"},{level:2,title:"0.1.0",slug:"_0-1-0"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Server-side installation",frontmatter:{},regularPath:"/guide/server-side-installation.html",relativePath:"guide/server-side-installation.md",key:"v-7dcddcc2",path:"/guide/server-side-installation.html",headers:[{level:2,title:"Install with npm or Yarn",slug:"install-with-npm-or-yarn"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Sorting data",frontmatter:{},regularPath:"/guide/sorting-data.html",relativePath:"guide/sorting-data.md",key:"v-2c054345",path:"/guide/sorting-data.html",headers:[{level:2,title:"Sorting data in HyperFormula",slug:"sorting-data-in-hyperformula"},{level:2,title:"Sorting rows",slug:"sorting-rows"},{level:3,title:"Step 1: Choose a new row order",slug:"step-1-choose-a-new-row-order"},{level:3,title:"Step 2: Check if the new row order can be applied",slug:"step-2-check-if-the-new-row-order-can-be-applied"},{level:3,title:"Step 3: Set the new row order",slug:"step-3-set-the-new-row-order"},{level:2,title:"Sorting columns",slug:"sorting-columns"},{level:3,title:"Step 1: Choose a new column order",slug:"step-1-choose-a-new-column-order"},{level:3,title:"Step 2: Check if the new column order can be applied",slug:"step-2-check-if-the-new-column-order-can-be-applied"},{level:3,title:"Step 3: Set the new column order",slug:"step-3-set-the-new-column-order"},{level:2,title:"Data sorting demo",slug:"data-sorting-demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Specifications and limits",frontmatter:{},regularPath:"/guide/specifications-and-limits.html",relativePath:"guide/specifications-and-limits.md",key:"v-e6ef97b6",path:"/guide/specifications-and-limits.html",headers:[{level:2,title:"Sheet and cell limits",slug:"sheet-and-cell-limits"},{level:2,title:"Calculation limits",slug:"calculation-limits"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Support",frontmatter:{},regularPath:"/guide/support.html",relativePath:"guide/support.md",key:"v-362e1525",path:"/guide/support.html",headers:[{level:2,title:"Community support",slug:"community-support"},{level:2,title:"Premium support",slug:"premium-support"},{level:2,title:"Consulting services",slug:"consulting-services"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Supported browsers",frontmatter:{},regularPath:"/guide/supported-browsers.html",relativePath:"guide/supported-browsers.md",key:"v-5d69bcd2",path:"/guide/supported-browsers.html",headers:[{level:2,title:"List of supported browsers",slug:"list-of-supported-browsers"},{level:2,title:"Full ICU support",slug:"full-icu-support"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of errors",frontmatter:{},regularPath:"/guide/types-of-errors.html",relativePath:"guide/types-of-errors.md",key:"v-656b0965",path:"/guide/types-of-errors.html",version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of operators",frontmatter:{},regularPath:"/guide/types-of-operators.html",relativePath:"guide/types-of-operators.md",key:"v-6f197f91",path:"/guide/types-of-operators.html",headers:[{level:2,title:"Unary operators",slug:"unary-operators"},{level:2,title:"Binary arithmetic operators",slug:"binary-arithmetic-operators"},{level:2,title:"Comparison operators",slug:"comparison-operators"},{level:3,title:"Type coercion",slug:"type-coercion"},{level:2,title:"Boolean to int coercion, basic arithmetic operations",slug:"boolean-to-int-coercion-basic-arithmetic-operations"},{level:3,title:"a) true and null",slug:"a-true-and-null"},{level:3,title:"b) null and true",slug:"b-null-and-true"},{level:3,title:"c) true and true",slug:"c-true-and-true"},{level:3,title:"d) false and true",slug:"d-false-and-true"},{level:3,title:"e) true and false",slug:"e-true-and-false"},{level:3,title:"f) false and false",slug:"f-false-and-false"},{level:3,title:"g) null and false",slug:"g-null-and-false"},{level:2,title:"Order operations, comparisons",slug:"order-operations-comparisons"},{level:3,title:'a) Empty string ("") and null',slug:"a-empty-string-and-null"},{level:3,title:'b) String ("string") and boolean',slug:"b-string-string-and-boolean"},{level:3,title:"c) Null and false",slug:"c-null-and-false"},{level:3,title:"d) Null and positive integer",slug:"d-null-and-positive-integer"},{level:3,title:"e) Negative integer and null",slug:"e-negative-integer-and-null"},{level:3,title:"f) 0 and null",slug:"f-0-and-null"},{level:3,title:"g) 0 and false",slug:"g-0-and-false"},{level:3,title:"h) Positive integer and true",slug:"h-positive-integer-and-true"},{level:2,title:"Comparing strings",slug:"comparing-strings"},{level:2,title:"Concatenation operator",slug:"concatenation-operator"},{level:2,title:"Reference operators",slug:"reference-operators"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Types of values",frontmatter:{},regularPath:"/guide/types-of-values.html",relativePath:"guide/types-of-values.md",key:"v-593f2cf6",path:"/guide/types-of-values.html",headers:[{level:2,title:"Date and time values",slug:"date-and-time-values"},{level:2,title:"Getting cell type",slug:"getting-cell-type"},{level:2,title:"Getting cell value type",slug:"getting-cell-value-type"},{level:2,title:"Getting detailed cell value type",slug:"getting-detailed-cell-value-type"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Undo-redo",frontmatter:{},regularPath:"/guide/undo-redo.html",relativePath:"guide/undo-redo.md",key:"v-5f9445a5",path:"/guide/undo-redo.html",headers:[{level:2,title:"isThereSomething* methods",slug:"istheresomething-methods"},{level:2,title:"Batch operations",slug:"batch-operations"},{level:2,title:"Demo",slug:"demo"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394},{title:"Volatile functions",frontmatter:{},regularPath:"/guide/volatile-functions.html",relativePath:"guide/volatile-functions.md",key:"v-47182957",path:"/guide/volatile-functions.html",headers:[{level:2,title:"Volatile functions",slug:"volatile-functions-2"},{level:2,title:"Volatile actions",slug:"volatile-actions"},{level:2,title:"Tweaking performance",slug:"tweaking-performance"},{level:2,title:"Volatile custom functions",slug:"volatile-custom-functions"}],version:"2.6.0",buildDate:"26/09/2023 14:21:35",releaseDate:"19/09/2023",functionsCount:394}],themeConfig:{logo:"/logo.png",nextLinks:!0,prevLinks:!0,repo:"handsontable/hyperformula",docsRepo:"handsontable/hyperformula",docsDir:"docs",docsBranch:"master",editLinks:!0,editLinkText:"Help us improve this page",lastUpdated:!1,smoothScroll:!1,searchPlaceholder:"Search...",searchLimitApi:10,searchLimitGuide:10,nav:[{text:"Guide",link:"/"},{text:"API Reference",link:"/api/"}],displayAllHeaders:!1,activeHeaderLinks:!0,sidebarDepth:1,sidebar:{"/api/":[{title:"Introduction",path:"/api/"},{title:"HyperFormula Class",path:"/api/classes/hyperformula",collapsable:!0},{title:"Configuration Options",path:"/api/interfaces/configparams",collapsable:!0},{title:"Event Types",path:"/api/interfaces/listeners",alias:"/api/events",collapsable:!0},{title:"Error Types",collapsable:!0,children:[]}],"/":[{title:"Introduction",collapsable:!1,children:[["/","Welcome"],["/guide/demo","Demo"]]},{title:"Overview",collapsable:!1,children:[["/guide/supported-browsers","Supported browsers"],["/guide/dependencies","Dependencies"],["/guide/licensing","Licensing"],["/guide/support","Support"]]},{title:"Getting started",collapsable:!1,children:[["/guide/client-side-installation","Client-side installation"],["/guide/server-side-installation","Server-side installation"],["/guide/basic-usage","Basic usage"],["/guide/advanced-usage","Advanced usage"],["/guide/configuration-options","Configuration options"],["/guide/license-key","License key"]]},{title:"Framework integration",collapsable:!1,children:[["/guide/integration-with-react","Integration with React"],["/guide/integration-with-vue","Integration with Vue"],["/guide/integration-with-angular","Integration with Angular"]]},{title:"Data operations",collapsable:!1,children:[["/guide/basic-operations","Basic operations"],["/guide/batch-operations","Batch operations"],["/guide/clipboard-operations","Clipboard operations"],["/guide/undo-redo","Undo-redo"],["/guide/sorting-data","Sorting data"]]},{title:"Formulas",collapsable:!1,children:[["/guide/specifications-and-limits","Specifications and limits"],["/guide/cell-references","Cell references"],["/guide/types-of-values","Types of values"],["/guide/types-of-errors","Types of errors"],["/guide/types-of-operators","Types of operators"],["/guide/order-of-precendece","Order of precedence"],["/guide/built-in-functions","Built-in functions"],["/guide/volatile-functions","Volatile functions"],["/guide/named-expressions","Named expressions"],["/guide/arrays","Array formulas"]]},{title:"Internationalization",collapsable:!1,children:[["/guide/i18n-features","Internationalization features"],["/guide/localizing-functions","Localizing functions"],["/guide/date-and-time-handling","Date and time handling"]]},{title:"Compatibility",collapsable:!1,children:[["/guide/compatibility-with-microsoft-excel","Compatibility with Microsoft Excel"],["/guide/compatibility-with-google-sheets","Compatibility with Google Sheets"],["/guide/list-of-differences","Runtime differences with Microsoft Excel and Google Sheets"]]},{title:"Advanced topics",collapsable:!1,children:[["/guide/key-concepts","Key concepts"],["/guide/dependency-graph","Dependency graph"],["/guide/building","Building & testing"],["/guide/custom-functions","Custom functions"],["/guide/performance","Performance"],["/guide/known-limitations","Known limitations"],["/guide/file-import","File import"]]},{title:"Upgrade and migration",collapsable:!1,children:[["/guide/release-notes","Release notes"],["/guide/migration-from-0.6-to-1.0","Migrating from 0.6 to 1.0"],["/guide/migration-from-1.0-to-2.0","Migrating from 1.x to 2.0"]]},{title:"Miscellaneous",collapsable:!1,children:[["/guide/contributing","Contributing"],["/guide/code-of-conduct.md","Code of conduct"],["/guide/branding","Branding"],["/guide/contact","Contact"]]}]}}};n(234);qn.component("graph",()=>Promise.all([n.e(0),n.e(14),n.e(20)]).then(n.bind(null,316))),qn.component("Badge",()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,317))),qn.component("CodeBlock",()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,312))),qn.component("CodeGroup",()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,313)));n(235);var Al=[({router:e})=>{e.addRoutes([{path:"/guide/",redirect:"/"}])},{},({Vue:e})=>{e.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{}],Tl=[];class Dl extends class{constructor(){this.store=new qn({data:{state:{}}})}$get(e){return this.store.state[e]}$set(e,t){qn.set(this.store.state,e,t)}$emit(...e){this.store.$emit(...e)}$on(...e){this.store.$on(...e)}}{}Object.assign(Dl.prototype,{getPageAsyncComponent:al,getLayoutAsyncComponent:ll,getAsyncComponent:sl,getVueComponent:ul});var Ll={install(e){const t=new Dl;e.$vuepress=t,e.prototype.$vuepress=t}};function Rl(e,t){const n=t.toLowerCase();return e.options.routes.some(e=>e.path.toLowerCase()===n)}var Il={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(e){const t=this.pageKey||this.$parent.$page.key;return fl("pageKey",t),qn.component(t)||qn.component(t,al(t)),qn.component(t)?e(t):e("")}},Fl={functional:!0,props:{slotKey:String,required:!0},render:(e,{props:t,slots:n})=>e("div",{class:["content__"+t.slotKey]},n()[t.slotKey])},Ml={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Nl=(n(236),n(237),Object(Ol.a)(Ml,(function(){var e=this._self._c;return e("span",[e("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[e("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),e("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),e("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),zl={functional:!0,render(e,{parent:t,children:n}){if(t._isMounted)return n;t.$once("hook:mounted",()=>{t.$forceUpdate()})}};qn.config.productionTip=!1,qn.use(Ha),qn.use(Ll),qn.mixin(function(e,t,n=qn){!function(e){e.locales&&Object.keys(e.locales).forEach(t=>{e.locales[t].path=t});Object.freeze(e)}(t),n.$vuepress.$set("siteData",t);const r=new(e(n.$vuepress.$get("siteData"))),i=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(r)),o={};return Object.keys(i).reduce((e,t)=>(t.startsWith("$")&&(e[t]=i[t].get),e),o),{computed:o}}(e=>class{setPage(e){this.__page=e}get $site(){return e}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:e={}}=this.$site;let t,n;for(const r in e)"/"===r?n=e[r]:0===this.$page.path.indexOf(r)&&(t=e[r]);return t||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:e}=this.$page.frontmatter;return"string"==typeof e&&e}get $title(){const e=this.$page,{metaTitle:t}=this.$page.frontmatter;if("string"==typeof t)return t;const n=this.$siteTitle,r=e.frontmatter.home?null:e.frontmatter.title||e.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const e=function(e){if(e){const t=e.filter(e=>"description"===e.name)[0];if(t)return t.content}}(this.$page.frontmatter.meta);return e||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(e,t){for(let n=0;nn||(e.hash?!qn.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(e.hash)}:{x:0,y:0})});!function(e){e.beforeEach((t,n,r)=>{if(Rl(e,t.path))r();else if(/(\/|\.html)$/.test(t.path))if(/\/$/.test(t.path)){const n=t.path.replace(/\/$/,"")+".html";Rl(e,n)?r(n):r()}else r();else{const n=t.path+"/",i=t.path+".html";Rl(e,i)?r(i):Rl(e,n)?r(n):r()}})}(n);const r={};try{await Promise.all(Al.filter(e=>"function"==typeof e).map(t=>t({Vue:qn,options:r,router:n,siteData:jl,isServer:e})))}catch(e){console.error(e)}return{app:new qn(Object.assign(r,{router:n,render:e=>e("div",{attrs:{id:"app"}},[e("RouterView",{ref:"layout"}),e("div",{class:"global-ui"},Tl.map(t=>e(t)))])})),router:n}}(!1).then(({app:e,router:t})=>{t.onReady(()=>{e.$mount("#app")})})}]); \ No newline at end of file diff --git a/guide/advanced-usage.html b/guide/advanced-usage.html index 34b949a6f..eac9abff6 100644 --- a/guide/advanced-usage.html +++ b/guide/advanced-usage.html @@ -19,7 +19,7 @@ - + @@ -128,6 +128,6 @@ →

- + \ No newline at end of file diff --git a/guide/arrays.html b/guide/arrays.html index 4f70b07ff..32cc40fe1 100644 --- a/guide/arrays.html +++ b/guide/arrays.html @@ -19,7 +19,7 @@ - + @@ -77,6 +77,6 @@ →

- + \ No newline at end of file diff --git a/guide/basic-operations.html b/guide/basic-operations.html index 96f5c6220..f4f6a6b6e 100644 --- a/guide/basic-operations.html +++ b/guide/basic-operations.html @@ -19,7 +19,7 @@ - + @@ -227,6 +227,6 @@ →

- + \ No newline at end of file diff --git a/guide/basic-usage.html b/guide/basic-usage.html index cc4acc0ef..428d510e7 100644 --- a/guide/basic-usage.html +++ b/guide/basic-usage.html @@ -19,7 +19,7 @@ - + @@ -74,6 +74,6 @@ →

- + \ No newline at end of file diff --git a/guide/batch-operations.html b/guide/batch-operations.html index 931e32338..1c2f7cab9 100644 --- a/guide/batch-operations.html +++ b/guide/batch-operations.html @@ -19,7 +19,7 @@ - + @@ -110,6 +110,6 @@ →

- + \ No newline at end of file diff --git a/guide/branding.html b/guide/branding.html index d0dc055f0..f6e7f59b0 100644 --- a/guide/branding.html +++ b/guide/branding.html @@ -19,7 +19,7 @@ - + @@ -53,6 +53,6 @@ →

- + \ No newline at end of file diff --git a/guide/building.html b/guide/building.html index 9435b7a61..59030f9b0 100644 --- a/guide/building.html +++ b/guide/building.html @@ -19,7 +19,7 @@ - + @@ -65,6 +65,6 @@ →

- + \ No newline at end of file diff --git a/guide/built-in-functions.html b/guide/built-in-functions.html index c0fd17ca7..7c3ffdcfc 100644 --- a/guide/built-in-functions.html +++ b/guide/built-in-functions.html @@ -19,7 +19,7 @@ - + @@ -63,6 +63,6 @@ →

- + \ No newline at end of file diff --git a/guide/cell-references.html b/guide/cell-references.html index cd1e4ed73..b887b78b6 100644 --- a/guide/cell-references.html +++ b/guide/cell-references.html @@ -19,7 +19,7 @@ - + @@ -97,6 +97,6 @@ →

- + \ No newline at end of file diff --git a/guide/client-side-installation.html b/guide/client-side-installation.html index c9351bc8c..d75572708 100644 --- a/guide/client-side-installation.html +++ b/guide/client-side-installation.html @@ -19,7 +19,7 @@ - + @@ -71,6 +71,6 @@ →

- + \ No newline at end of file diff --git a/guide/clipboard-operations.html b/guide/clipboard-operations.html index 47b4a1204..1d89f323d 100644 --- a/guide/clipboard-operations.html +++ b/guide/clipboard-operations.html @@ -19,7 +19,7 @@ - + @@ -80,6 +80,6 @@ →

- + \ No newline at end of file diff --git a/guide/code-of-conduct.html b/guide/code-of-conduct.html index f0ac0cacc..d9b9ec136 100644 --- a/guide/code-of-conduct.html +++ b/guide/code-of-conduct.html @@ -19,7 +19,7 @@ - + @@ -100,6 +100,6 @@ →

- + \ No newline at end of file diff --git a/guide/compatibility-with-google-sheets.html b/guide/compatibility-with-google-sheets.html index 173682202..a9de7fffc 100644 --- a/guide/compatibility-with-google-sheets.html +++ b/guide/compatibility-with-google-sheets.html @@ -19,7 +19,7 @@ - + @@ -70,6 +70,6 @@ →

- + \ No newline at end of file diff --git a/guide/compatibility-with-microsoft-excel.html b/guide/compatibility-with-microsoft-excel.html index c339f5f4d..e80377aba 100644 --- a/guide/compatibility-with-microsoft-excel.html +++ b/guide/compatibility-with-microsoft-excel.html @@ -19,7 +19,7 @@ - + @@ -98,6 +98,6 @@ →

- + \ No newline at end of file diff --git a/guide/configuration-options.html b/guide/configuration-options.html index 70e40422d..56e60e084 100644 --- a/guide/configuration-options.html +++ b/guide/configuration-options.html @@ -19,7 +19,7 @@ - + @@ -60,6 +60,6 @@ →

- + \ No newline at end of file diff --git a/guide/contact.html b/guide/contact.html index 5b47640ae..9f7e5f034 100644 --- a/guide/contact.html +++ b/guide/contact.html @@ -19,7 +19,7 @@ - + @@ -49,6 +49,6 @@

- + \ No newline at end of file diff --git a/guide/contributing.html b/guide/contributing.html index fa290b432..f681cdbc9 100644 --- a/guide/contributing.html +++ b/guide/contributing.html @@ -19,7 +19,7 @@ - + @@ -63,6 +63,6 @@ →

- + \ No newline at end of file diff --git a/guide/custom-functions.html b/guide/custom-functions.html index 73548d056..65132bf37 100644 --- a/guide/custom-functions.html +++ b/guide/custom-functions.html @@ -19,7 +19,7 @@ - + @@ -336,6 +336,6 @@ →

- + \ No newline at end of file diff --git a/guide/date-and-time-handling.html b/guide/date-and-time-handling.html index 840629ed6..a8d517a0b 100644 --- a/guide/date-and-time-handling.html +++ b/guide/date-and-time-handling.html @@ -19,7 +19,7 @@ - + @@ -93,6 +93,6 @@ →

- + \ No newline at end of file diff --git a/guide/demo.html b/guide/demo.html index 173f01409..55e68fc5b 100644 --- a/guide/demo.html +++ b/guide/demo.html @@ -19,7 +19,7 @@ - + @@ -47,6 +47,6 @@ →

- + \ No newline at end of file diff --git a/guide/dependencies.html b/guide/dependencies.html index c7e26d62a..222102b89 100644 --- a/guide/dependencies.html +++ b/guide/dependencies.html @@ -19,7 +19,7 @@ - + @@ -50,6 +50,6 @@ →

- + \ No newline at end of file diff --git a/guide/dependency-graph.html b/guide/dependency-graph.html index c404b8949..18eab50c0 100644 --- a/guide/dependency-graph.html +++ b/guide/dependency-graph.html @@ -19,7 +19,7 @@ - + @@ -98,6 +98,6 @@ →

- + \ No newline at end of file diff --git a/guide/file-import.html b/guide/file-import.html index 94c4abd79..47ca0a293 100644 --- a/guide/file-import.html +++ b/guide/file-import.html @@ -19,7 +19,7 @@ - + @@ -89,6 +89,6 @@ →

- + \ No newline at end of file diff --git a/guide/i18n-features.html b/guide/i18n-features.html index 41730a28c..a67d855a2 100644 --- a/guide/i18n-features.html +++ b/guide/i18n-features.html @@ -19,7 +19,7 @@ - + @@ -63,6 +63,6 @@ →

- + \ No newline at end of file diff --git a/guide/integration-with-angular.html b/guide/integration-with-angular.html index 39abdd009..f6b2c0100 100644 --- a/guide/integration-with-angular.html +++ b/guide/integration-with-angular.html @@ -19,7 +19,7 @@ - + @@ -41,7 +41,7 @@ (opens new window)

# Integration with Angular

The installation process for applications written in Angular is the same as in the case of VanillaJS. You can check the client-side installation section for -more details.

# Demo

← →

- + \ No newline at end of file diff --git a/guide/integration-with-react.html b/guide/integration-with-react.html index 1574bf2d3..0718a1b9e 100644 --- a/guide/integration-with-react.html +++ b/guide/integration-with-react.html @@ -19,7 +19,7 @@ - + @@ -50,6 +50,6 @@ →

- + \ No newline at end of file diff --git a/guide/integration-with-vue.html b/guide/integration-with-vue.html index bcbc9abb6..b3c587914 100644 --- a/guide/integration-with-vue.html +++ b/guide/integration-with-vue.html @@ -19,7 +19,7 @@ - + @@ -50,6 +50,6 @@ →

- + \ No newline at end of file diff --git a/guide/key-concepts.html b/guide/key-concepts.html index 87c6b293c..8d1d43a45 100644 --- a/guide/key-concepts.html +++ b/guide/key-concepts.html @@ -19,7 +19,7 @@ - + @@ -92,6 +92,6 @@ →

- + \ No newline at end of file diff --git a/guide/known-limitations.html b/guide/known-limitations.html index 997014284..a354af572 100644 --- a/guide/known-limitations.html +++ b/guide/known-limitations.html @@ -19,7 +19,7 @@ - + @@ -59,6 +59,6 @@ →

- + \ No newline at end of file diff --git a/guide/license-key.html b/guide/license-key.html index 73649ad3f..a477a21e7 100644 --- a/guide/license-key.html +++ b/guide/license-key.html @@ -19,7 +19,7 @@ - + @@ -61,6 +61,6 @@ →

- + \ No newline at end of file diff --git a/guide/licensing.html b/guide/licensing.html index 87db2093d..d41dfd92d 100644 --- a/guide/licensing.html +++ b/guide/licensing.html @@ -19,7 +19,7 @@ - + @@ -48,6 +48,6 @@ →

- + \ No newline at end of file diff --git a/guide/list-of-differences.html b/guide/list-of-differences.html index c43ef0ef6..fa3d9739d 100644 --- a/guide/list-of-differences.html +++ b/guide/list-of-differences.html @@ -19,7 +19,7 @@ - + @@ -53,6 +53,6 @@ →

- + \ No newline at end of file diff --git a/guide/localizing-functions.html b/guide/localizing-functions.html index 34809c011..efca6f852 100644 --- a/guide/localizing-functions.html +++ b/guide/localizing-functions.html @@ -19,7 +19,7 @@ - + @@ -81,6 +81,6 @@ →

- + \ 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 491debd03..160f2fa56 100644 --- a/guide/migration-from-0.6-to-1.0.html +++ b/guide/migration-from-0.6-to-1.0.html @@ -19,7 +19,7 @@ - + @@ -95,6 +95,6 @@ →

- + \ No newline at end of file diff --git a/guide/migration-from-1.0-to-2.0.html b/guide/migration-from-1.0-to-2.0.html index 8cc180849..74ce9e485 100644 --- a/guide/migration-from-1.0-to-2.0.html +++ b/guide/migration-from-1.0-to-2.0.html @@ -19,7 +19,7 @@ - + @@ -55,6 +55,6 @@ →

- + \ No newline at end of file diff --git a/guide/named-expressions.html b/guide/named-expressions.html index 99d71cf5d..4b7a8a85a 100644 --- a/guide/named-expressions.html +++ b/guide/named-expressions.html @@ -19,7 +19,7 @@ - + @@ -107,6 +107,6 @@ →

- + \ No newline at end of file diff --git a/guide/order-of-precendece.html b/guide/order-of-precendece.html index c8be91681..9c3138fa8 100644 --- a/guide/order-of-precendece.html +++ b/guide/order-of-precendece.html @@ -19,7 +19,7 @@ - + @@ -59,6 +59,6 @@ →

- + \ No newline at end of file diff --git a/guide/performance.html b/guide/performance.html index d5c22ccb6..6aa2bdf79 100644 --- a/guide/performance.html +++ b/guide/performance.html @@ -19,7 +19,7 @@ - + @@ -84,6 +84,6 @@ →

- + \ No newline at end of file diff --git a/guide/release-notes.html b/guide/release-notes.html index f41fe6dbf..0d153ba5e 100644 --- a/guide/release-notes.html +++ b/guide/release-notes.html @@ -19,7 +19,7 @@ - + @@ -207,6 +207,6 @@ →

- + \ No newline at end of file diff --git a/guide/server-side-installation.html b/guide/server-side-installation.html index 754ef90a7..d8b661a7f 100644 --- a/guide/server-side-installation.html +++ b/guide/server-side-installation.html @@ -19,7 +19,7 @@ - + @@ -59,6 +59,6 @@ →

- + \ No newline at end of file diff --git a/guide/sorting-data.html b/guide/sorting-data.html index a12878fa7..3e7519e92 100644 --- a/guide/sorting-data.html +++ b/guide/sorting-data.html @@ -19,7 +19,7 @@ - + @@ -162,6 +162,6 @@ →

- + \ No newline at end of file diff --git a/guide/specifications-and-limits.html b/guide/specifications-and-limits.html index 5a643a20c..0c705855d 100644 --- a/guide/specifications-and-limits.html +++ b/guide/specifications-and-limits.html @@ -19,7 +19,7 @@ - + @@ -51,6 +51,6 @@ →

- + \ No newline at end of file diff --git a/guide/support.html b/guide/support.html index e0fdbb5d1..ff9512f24 100644 --- a/guide/support.html +++ b/guide/support.html @@ -19,7 +19,7 @@ - + @@ -53,6 +53,6 @@ →

- + \ No newline at end of file diff --git a/guide/supported-browsers.html b/guide/supported-browsers.html index 83b4ae3ed..d8e830415 100644 --- a/guide/supported-browsers.html +++ b/guide/supported-browsers.html @@ -19,7 +19,7 @@ - + @@ -56,6 +56,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-errors.html b/guide/types-of-errors.html index 28403ff7f..042683c77 100644 --- a/guide/types-of-errors.html +++ b/guide/types-of-errors.html @@ -19,7 +19,7 @@ - + @@ -55,6 +55,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-operators.html b/guide/types-of-operators.html index 772dec1a2..f07f84c50 100644 --- a/guide/types-of-operators.html +++ b/guide/types-of-operators.html @@ -19,7 +19,7 @@ - + @@ -80,6 +80,6 @@ →

- + \ No newline at end of file diff --git a/guide/types-of-values.html b/guide/types-of-values.html index 54fa231da..72367e34e 100644 --- a/guide/types-of-values.html +++ b/guide/types-of-values.html @@ -19,7 +19,7 @@ - + @@ -68,6 +68,6 @@ →

- + \ No newline at end of file diff --git a/guide/undo-redo.html b/guide/undo-redo.html index f1f3cdb21..ef6cb4688 100644 --- a/guide/undo-redo.html +++ b/guide/undo-redo.html @@ -19,7 +19,7 @@ - + @@ -56,6 +56,6 @@ →

- + \ No newline at end of file diff --git a/guide/volatile-functions.html b/guide/volatile-functions.html index 5d7ba4a18..919f57ef8 100644 --- a/guide/volatile-functions.html +++ b/guide/volatile-functions.html @@ -19,7 +19,7 @@ - + @@ -72,6 +72,6 @@ →

- + \ No newline at end of file diff --git a/index.html b/index.html index 0280ef4ae..b6d409cf0 100644 --- a/index.html +++ b/index.html @@ -19,7 +19,7 @@ - + @@ -50,6 +50,6 @@ →

- + \ No newline at end of file