ConfigParams

Interface

License

licenseKey

• licenseKey: string

Defined in hyperformula/src/ConfigParams.ts:186

Sets your HyperFormula license key.

To use HyperFormula on the GPLv3 license terms, set this option to gpl-v3.

To use HyperFormula with your proprietary license, set this option to your valid license key string.

For more information, go here.

default undefined

Engine

chooseAddressMappingPolicy

• chooseAddressMappingPolicy: ChooseAddressMapping

Defined in hyperformula/src/ConfigParams.ts:55

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.

For more information, see the Performance guide.

default AlwaysDense

context

• context: unknown

Defined in hyperformula/src/ConfigParams.ts:63

A generic parameter that can be used to pass data to custom functions.

For more information, see the Custom functions guide.

default undefined

evaluateNullToZero

• evaluateNullToZero: boolean

Defined in hyperformula/src/ConfigParams.ts:129

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

The same applies to an empty cell read through the API: getCellValue(), getSheetValues() and the other methods that return cell values, as well as the changes passed to the valuesUpdated event, give 0 for it instead of null. ISBLANK still treats the cell as blank.

default false

maxColumns

• maxColumns: number

Defined in hyperformula/src/ConfigParams.ts:232

Sets the maximum number of columns.

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

maxPendingLazyTransformations

• maxPendingLazyTransformations: number

Defined in hyperformula/src/ConfigParams.ts:439

Controls memory usage for long-running instances by limiting the number of pending lazy transformations before cleanup occurs.

Structural operations (adding/removing rows/columns, moving cells) create transformations that are applied lazily to formulas. This setting determines how many can accumulate before they are flushed and memory is reclaimed.

Lower values reduce peak memory usage but may slightly increase CPU overhead. Higher values reduce overhead but allow more memory accumulation.

default 50

maxRows

• maxRows: number

Defined in hyperformula/src/ConfigParams.ts:226

Sets the maximum number of rows.

default 40.000

useArrayArithmetic

• useArrayArithmetic: boolean

Defined in hyperformula/src/ConfigParams.ts:396

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 hyperformula/src/ConfigParams.ts:408

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).

For more information, see the Performance guide.

default false

useStats

• useStats: boolean

Defined in hyperformula/src/ConfigParams.ts:416

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

Useful for testing and benchmarking.

default false

Formula Syntax

arrayColumnSeparator

• arrayColumnSeparator: “,” | “;”

Defined in hyperformula/src/ConfigParams.ts:212

Sets a column separator symbol for array notation.

For more information, see the Arrays guide.

default ‘,’

arrayRowSeparator

• arrayRowSeparator: “;” | “|”

Defined in hyperformula/src/ConfigParams.ts:220

Sets a row separator symbol for array notation.

For more information, see the Arrays guide.

default ‘;’

functionArgSeparator

• functionArgSeparator: string

Defined in hyperformula/src/ConfigParams.ts:105

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 hyperformula/src/ConfigParams.ts:138

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

For more information, see the Custom functions guide.

default []

ignoreWhiteSpace

• ignoreWhiteSpace: “standard” | “any”

Defined in hyperformula/src/ConfigParams.ts:164

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 hyperformula/src/ConfigParams.ts:154

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 hyperformula/src/ConfigParams.ts:424

Sets the number of elements kept in the undo history.

For more information, see the Undo-Redo guide.

default 20

Date and Time

dateFormats

• dateFormats: string[]

Defined in hyperformula/src/ConfigParams.ts:95

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 hyperformula/src/ConfigParams.ts:174

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 the Date and time handling guide and nullDate.

default false

nullDate

• nullDate: SimpleDate

Defined in hyperformula/src/ConfigParams.ts:242

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 hyperformula/src/ConfigParams.ts:256

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.

For more information, see the Date and time handling guide.

default 30

parseDateTime

• parseDateTime: function

Defined in hyperformula/src/ConfigParams.ts:266

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 hyperformula/src/ConfigParams.ts:306

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 hyperformula/src/ConfigParams.ts:316

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 hyperformula/src/ConfigParams.ts:386

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 hyperformula/src/ConfigParams.ts:71

Sets symbols that denote currency numbers.

For more information, see the Internationalization features guide.

default [‘$’]

decimalSeparator

• decimalSeparator: “.” | “,”

Defined in hyperformula/src/ConfigParams.ts:119

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 hyperformula/src/ConfigParams.ts:281

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 hyperformula/src/ConfigParams.ts:296

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).

Setting precisionRounding too high will expose the floating-point calculation errors. For example, with precisionRounding set to 15, 0.1 + 0.2 results in 0.3000000000000001.

default 10

smartRounding

• smartRounding: boolean

Defined in hyperformula/src/ConfigParams.ts:340

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

stringifyCurrency

• stringifyCurrency: function

Defined in hyperformula/src/ConfigParams.ts:332

Sets a function that converts numeric values into currency-formatted strings.

The function receives the raw value and the format string passed to TEXT and should return a string or undefined. The formatter calls this for every format string that reaches it, not only currency-shaped ones — return undefined for any format your callback does not handle and HyperFormula will fall through to the built-in number formatter.

For more information, see the Currency handling guide.

default defaultStringifyCurrency