# HyperFormula API reference

# Type aliases

# CellDependency

Ƭ CellDependency: SimpleCellAddress | AbsoluteCellRange | NamedExpressionDependency

Defined in src/CellDependency.ts:10 (opens new window)


# CellValue

Ƭ CellValue: NoErrorCellValue | DetailedCellError

Defined in src/CellValue.ts:9 (opens new window)


# CellValueDetailedType

Ƭ CellValueDetailedType: CellValueNoNumber | NumberType

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


# CellValueType

Ƭ CellValueType: CellValueNoNumber | CellValueJustNumber

Defined in src/Cell.ts:91 (opens new window)


# ChangeList

Ƭ ChangeList: CellValueChange[]

Defined in src/ContentChanges.ts:20 (opens new window)


# ClipboardCell

Ƭ ClipboardCell: ClipboardCellValue | ClipboardCellFormula | ClipboardCellEmpty | ClipboardCellParsingError

Defined in src/ClipboardOperations.ts:16 (opens new window)


# ColumnMap

Ƭ ColumnMap: Map‹RawInterpreterValue, ValueIndex

Defined in src/Lookup/ColumnIndex.ts:30 (opens new window)


# ColumnRowIndex

Ƭ ColumnRowIndex: [number, number]

Defined in src/CrudOperations.ts:65 (opens new window)


# ConfigParamsList

Ƭ ConfigParamsList: keyof ConfigParams

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


# ConsoleMessages

Ƭ ConsoleMessages: object

Defined in src/helpers/licenseKeyValidator.ts:24 (opens new window)

# Type declaration:


# DateTime

Ƭ DateTime: SimpleTime | SimpleDate | SimpleDateTime

Defined in src/DateTimeHelper.ts:31 (opens new window)


# Dependencies

Ƭ Dependencies: Map‹Vertex, CellDependency[]›

Defined in src/GraphBuilder.ts:25 (opens new window)


# EngineState

Ƭ EngineState: object

Defined in src/BuildEngineFactory.ts:32 (opens new window)

# Type declaration:


# ExportedChange

Ƭ ExportedChange: ExportedCellChange | ExportedNamedExpressionChange

Defined in src/Exporter.ts:17 (opens new window)


# LicenseKeyInvalidState

Ƭ LicenseKeyInvalidState: Exclude‹LicenseKeyValidityState, VALID

Defined in src/helpers/licenseKeyValidator.ts:18 (opens new window)


# Maybe

Ƭ Maybe: T | undefined

Defined in src/Maybe.ts:6 (opens new window)

license Copyright (c) 2022 Handsoncode. All rights reserved.


# MessageDescriptor

Ƭ MessageDescriptor: object

Defined in src/helpers/licenseKeyValidator.ts:28 (opens new window)

# Type declaration:


# NamedExpressionOptions

Ƭ NamedExpressionOptions: Record‹string, string | number | boolean›

Defined in src/NamedExpressions.ts:17 (opens new window)


# NoErrorCellValue

Ƭ NoErrorCellValue: number | string | boolean | null

Defined in src/CellValue.ts:8 (opens new window)


# RawCellContent

Ƭ RawCellContent: Date | string | number | boolean | null | undefined

Defined in src/CellContentParser.ts:25 (opens new window)


# Sheet

Ƭ Sheet: RawCellContent[][]

Defined in src/Sheet.ts:12 (opens new window)

Two-dimenstional array representation of sheet


# SheetDimensions

Ƭ SheetDimensions: object

Defined in src/Sheet.ts:19 (opens new window)

Represents size of a sheet

# Type declaration:

  • height: number

  • width: number


# SheetIndex

Ƭ SheetIndex: ColumnMap[]

Defined in src/Lookup/ColumnIndex.ts:37 (opens new window)


# Sheets

Ƭ Sheets: Record‹string, Sheet

Defined in src/Sheet.ts:14 (opens new window)


# SimpleDateTime

Ƭ SimpleDateTime: SimpleDate & SimpleTime

Defined in src/DateTimeHelper.ts:29 (opens new window)


# Span

Ƭ Span: RowsSpan | ColumnsSpan

Defined in src/Span.ts:6 (opens new window)

license Copyright (c) 2022 Handsoncode. All rights reserved.


# TranslatableErrorType

Ƭ TranslatableErrorType: Exclude‹ErrorType, LIC

Defined in src/Cell.ts:51 (opens new window)

# Variables

# HOURS_PER_DAY Const

HOURS_PER_DAY: 24 = 24

Defined in src/DateTimeHelper.ts:15 (opens new window)


# MINUTES_PER_HOUR Const

MINUTES_PER_HOUR: 60 = 60

Defined in src/DateTimeHelper.ts:14 (opens new window)


# SECONDS_PER_MINUTE Const

SECONDS_PER_MINUTE: 60 = 60

Defined in src/DateTimeHelper.ts:13 (opens new window)


# WRONG_RANGE_SIZE Const

WRONG_RANGE_SIZE: "AbsoluteCellRange: Wrong range size" = "AbsoluteCellRange: Wrong range size"

Defined in src/AbsoluteCellRange.ts:22 (opens new window)


# _notified Let

_notified: boolean = false

Defined in src/helpers/licenseKeyValidator.ts:43 (opens new window)


# _rl Const

_rl: "length" = "length"

Defined in src/helpers/licenseKeyHelper.ts:8 (opens new window)

license Copyright (c) 2022 Handsoncode. All rights reserved.


# dateFormatRegex Const

dateFormatRegex: RegExp‹› = /(\.|dd|DD|d|D|mm|MM|m|M|YYYY|YY|yyyy|yy|HH|hh|H|h|ss(.(0+|s+))?|s|AM/PM|am/pm|A/P|a/p|[mm]|[MM]|[hh]|[HH])/g

Defined in src/format/parser.ts:8 (opens new window)


# defaultLanguage Const

defaultLanguage: string = Config.defaultConfig.language

Defined in src/index.ts:98 (opens new window)


# numDays Const

numDays: number[] = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]

Defined in src/DateTimeHelper.ts:10 (opens new window)


# numberFormatRegex Const

numberFormatRegex: RegExp‹› = /(\.|[#0]+(.[#0]*)?)/g

Defined in src/format/parser.ts:9 (opens new window)


# prefSumDays Const

prefSumDays: number[] = [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334]

Defined in src/DateTimeHelper.ts:11 (opens new window)


# privatePool Const

privatePool: WeakMap‹Config, object› = new WeakMap()

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


# secondsExtendedRegexp Const

secondsExtendedRegexp: RegExp‹› = /^ss(.(s+|0+))?$/

Defined in src/DateTimeDefault.ts:49 (opens new window)

# Functions

# CellValueTypeOrd Const

CellValueTypeOrd(arg: CellValueType): number

Defined in src/Cell.ts:97 (opens new window)

Parameters:

Name Type
arg CellValueType

Returns: number


# _cp Const

_cp(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:13 (opens new window)

Parameters:

Name Type
v any

Returns: number


# _hd Const

_hd(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:9 (opens new window)

Parameters:

Name Type
v any

Returns: number


# _nm Const

_nm(v: any): string

Defined in src/helpers/licenseKeyHelper.ts:11 (opens new window)

Parameters:

Name Type
v any

Returns: string


# _pi Const

_pi(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:10 (opens new window)

Parameters:

Name Type
v any

Returns: number


# _ss Const

_ss(v: any, s: any, l: any): any

Defined in src/helpers/licenseKeyHelper.ts:12 (opens new window)

Parameters:

Name Type
v any
s any
l any

Returns: any


# absoluteSheetReference Const

absoluteSheetReference(address: AddressWithSheet, baseAddress: SimpleCellAddress): number

Defined in src/Cell.ts:210 (opens new window)

Parameters:

Name Type
address AddressWithSheet
baseAddress SimpleCellAddress

Returns: number


# absolutizeDependencies Const

absolutizeDependencies(deps: RelativeDependency[], baseAddress: SimpleCellAddress): CellDependency[]

Defined in src/absolutizeDependencies.ts:17 (opens new window)

Converts dependencies from maybe relative addressing to absolute addressing.

Parameters:

Name Type Description
deps RelativeDependency[] list of addresses in R0C0 format
baseAddress SimpleCellAddress base address with regard to which make a convertion

Returns: CellDependency[]


# addressKey Const

addressKey(address: SimpleCellAddress): string

Defined in src/Cell.ts:200 (opens new window)

Parameters:

Name Type
address SimpleCellAddress

Returns: string


# arraySizeForBinaryOp

arraySizeForBinaryOp(leftArraySize: ArraySize, rightArraySize: ArraySize): ArraySize

Defined in src/ArraySize.ts:42 (opens new window)

Parameters:

Name Type
leftArraySize ArraySize
rightArraySize ArraySize

Returns: ArraySize


# arraySizeForUnaryOp

arraySizeForUnaryOp(arraySize: ArraySize): ArraySize

Defined in src/ArraySize.ts:46 (opens new window)

Parameters:

Name Type
arraySize ArraySize

Returns: ArraySize


# buildColumnSearchStrategy

buildColumnSearchStrategy(dependencyGraph: DependencyGraph, config: Config, statistics: Statistics): ColumnSearchStrategy

Defined in src/Lookup/SearchStrategy.ts:51 (opens new window)

Parameters:

Name Type
dependencyGraph DependencyGraph
config Config
statistics Statistics

Returns: ColumnSearchStrategy


# checkKeySchema

checkKeySchema(v: any): boolean

Defined in src/helpers/licenseKeyHelper.ts:19 (opens new window)

Parameters:

Name Type
v any

Returns: boolean


# checkLicenseKeyValidity

checkLicenseKeyValidity(licenseKey: string): LicenseKeyValidityState

Defined in src/helpers/licenseKeyValidator.ts:51 (opens new window)

Checks if the provided license key is grammatically valid or not expired.

Parameters:

Name Type Description
licenseKey string The license key to check.

Returns: LicenseKeyValidityState

Returns the checking state.


# collatorFromConfig

collatorFromConfig(config: Config): Collator

Defined in src/StringHelper.ts:8 (opens new window)

Parameters:

Name Type
config Config

Returns: Collator


# configCheckIfParametersNotInConflict

configCheckIfParametersNotInConflict(...params: object[]): void

Defined in src/ArgumentSanitization.ts:56 (opens new window)

Parameters:

Name Type
...params object[]

Returns: void


# configValueFromParam

configValueFromParam(inputValue: any, expectedType: string | string[], paramName: ConfigParamsList): any

Defined in src/ArgumentSanitization.ts:15 (opens new window)

Parameters:

Name Type
inputValue any
expectedType string | string[]
paramName ConfigParamsList

Returns: any


# configValueFromParamCheck

configValueFromParamCheck(inputValue: any, typeCheck: function, expectedType: string, paramName: ConfigParamsList): any

Defined in src/ArgumentSanitization.ts:46 (opens new window)

Parameters:

inputValue: any

typeCheck: function

▸ (object: any): boolean

Parameters:

Name Type
object any

expectedType: string

paramName: ConfigParamsList

Returns: any


# countChars

countChars(text: string, char: string): number

Defined in src/format/format.ts:45 (opens new window)

Parameters:

Name Type
text string
char string

Returns: number


# createTokens

createTokens(regexTokens: RegExpExecArray[], str: string): FormatToken[]

Defined in src/format/parser.ts:66 (opens new window)

Parameters:

Name Type
regexTokens RegExpExecArray[]
str string

Returns: FormatToken[]


# dayToMonth

dayToMonth(dayOfYear: number): number

Defined in src/DateTimeHelper.ts:270 (opens new window)

Parameters:

Name Type
dayOfYear number

Returns: number


# defaultParseToDate

defaultParseToDate(dateItems: string[], dateFormat: Maybe‹string›): MaybeSimpleDate

Defined in src/DateTimeDefault.ts:112 (opens new window)

Parameters:

Name Type
dateItems string[]
dateFormat Maybe‹string›

Returns: MaybeSimpleDate


# defaultParseToDateTime

defaultParseToDateTime(dateTimeString: string, dateFormat?: undefined | string, timeFormat?: undefined | string): MaybeDateTime

Defined in src/DateTimeDefault.ts:9 (opens new window)

Parameters:

Name Type
dateTimeString string
dateFormat? undefined | string
timeFormat? undefined | string

Returns: MaybeDateTime


# defaultParseToTime

defaultParseToTime(timeItems: string[], timeFormat: Maybe‹string›): MaybeSimpleTime

Defined in src/DateTimeDefault.ts:51 (opens new window)

Parameters:

Name Type
timeItems string[]
timeFormat Maybe‹string›

Returns: MaybeSimpleTime


# defaultStringifyDateTime

defaultStringifyDateTime(dateTime: SimpleDateTime, formatArg: string): Maybe‹string›

Defined in src/format/format.ts:145 (opens new window)

Parameters:

Name Type
dateTime SimpleDateTime
formatArg string

Returns: Maybe‹string›


# defaultStringifyDuration

defaultStringifyDuration(time: SimpleTime, formatArg: string): Maybe‹string›

Defined in src/format/format.ts:83 (opens new window)

Parameters:

Name Type
time SimpleTime
formatArg string

Returns: Maybe‹string›


# doesContainRelativeReferences Const

doesContainRelativeReferences(ast: Ast): boolean

Defined in src/NamedExpressions.ts:278 (opens new window)

Parameters:

Name Type
ast Ast

Returns: boolean


# empty

emptyT›(): IterableIterator‹T›

Defined in src/generatorUtils.ts:8 (opens new window)

Type parameters:

T

Returns: IterableIterator‹T›


# equalSimpleCellAddress Const

equalSimpleCellAddress(left: SimpleCellAddress, right: SimpleCellAddress): boolean

Defined in src/Cell.ts:214 (opens new window)

Parameters:

Name Type
left SimpleCellAddress
right SimpleCellAddress

Returns: boolean


# extractTime

extractTime(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:15 (opens new window)

Parameters:

Name Type
v any

Returns: number


# filterDependenciesOutOfScope Const

filterDependenciesOutOfScope(deps: CellDependency[]): (SimpleCellAddress | AbsoluteCellRange‹› | NamedExpressionDependency‹›)[]

Defined in src/absolutizeDependencies.ts:21 (opens new window)

Parameters:

Name Type
deps CellDependency[]

Returns: (SimpleCellAddress | AbsoluteCellRange‹› | NamedExpressionDependency‹›)[]


# findBoundaries

findBoundaries(sheet: Sheet): SheetBoundaries

Defined in src/Sheet.ts:49 (opens new window)

Returns actual width, height and fill ratio of a sheet

Parameters:

Name Type Description
sheet Sheet two-dimmensional array sheet representation

Returns: SheetBoundaries


# findInOrderedArray

findInOrderedArray(key: number, values: number[], handlingMisses: "lowerBound" | "upperBound"): number

Defined in src/Lookup/ColumnIndex.ts:321 (opens new window)

Parameters:

Name Type Default
key number -
values number[] -
handlingMisses "lowerBound" | "upperBound" "upperBound"

Returns: number


# first

firstT›(iterable: IterableIterator‹T›): Maybe‹T›

Defined in src/generatorUtils.ts:22 (opens new window)

Type parameters:

T

Parameters:

Name Type
iterable IterableIterator‹T›

Returns: Maybe‹T›


# format

format(value: number, formatArg: string, config: Config, dateHelper: DateTimeHelper): RawScalarValue

Defined in src/format/format.ts:13 (opens new window)

Parameters:

Name Type
value number
formatArg string
config Config
dateHelper DateTimeHelper

Returns: RawScalarValue


# formatDate

formatDate(date: Date): string

Defined in src/helpers/licenseKeyValidator.ts:91 (opens new window)

Formats a Date instance to hard-coded format MMMM DD, YYYY.

Parameters:

Name Type Description
date Date The date to format.

Returns: string


# formatToken

formatToken(type: TokenType, value: string): FormatToken

Defined in src/format/parser.ts:21 (opens new window)

Parameters:

Name Type
type TokenType
value string

Returns: FormatToken


# getCellType Const

getCellType(vertex: Maybe‹CellVertex›, address: SimpleCellAddress): CellType

Defined in src/Cell.ts:61 (opens new window)

Parameters:

Name Type
vertex Maybe‹CellVertex›
address SimpleCellAddress

Returns: CellType


# getCellValueDetailedType Const

getCellValueDetailedType(cellValue: InterpreterValue): CellValueDetailedType

Defined in src/Cell.ts:133 (opens new window)

Parameters:

Name Type
cellValue InterpreterValue

Returns: CellValueDetailedType


# getCellValueFormat Const

getCellValueFormat(cellValue: InterpreterValue): string | undefined

Defined in src/Cell.ts:141 (opens new window)

Parameters:

Name Type
cellValue InterpreterValue

Returns: string | undefined


# getCellValueType Const

getCellValueType(cellValue: InterpreterValue): CellValueType

Defined in src/Cell.ts:113 (opens new window)

Parameters:

Name Type
cellValue InterpreterValue

Returns: CellValueType


# 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


# instanceOfSimpleDate

instanceOfSimpleDate(obj: any): obj is SimpleDate

Defined in src/DateTimeHelper.ts:34 (opens new window)

Parameters:

Name Type
obj any

Returns: obj is SimpleDate


# instanceOfSimpleTime

instanceOfSimpleTime(obj: any): obj is SimpleTime

Defined in src/DateTimeHelper.ts:43 (opens new window)

Parameters:

Name Type
obj any

Returns: obj is SimpleTime


# invalidSimpleCellAddress Const

invalidSimpleCellAddress(address: SimpleCellAddress): boolean

Defined in src/Cell.ts:195 (opens new window)

Parameters:

Name Type
address SimpleCellAddress

Returns: boolean


# invalidSimpleColumnAddress Const

invalidSimpleColumnAddress(address: SimpleColumnAddress): boolean

Defined in src/Cell.ts:186 (opens new window)

Parameters:

Name Type
address SimpleColumnAddress

Returns: boolean


# invalidSimpleRowAddress Const

invalidSimpleRowAddress(address: SimpleRowAddress): boolean

Defined in src/Cell.ts:177 (opens new window)

Parameters:

Name Type
address SimpleRowAddress

Returns: boolean


# isBoolean

isBoolean(text: string): boolean

Defined in src/CellContentParser.ts:81 (opens new window)

Parameters:

Name Type
text string

Returns: boolean


# isError

isError(text: string, errorMapping: Record‹string, ErrorType›): boolean

Defined in src/CellContentParser.ts:86 (opens new window)

Parameters:

Name Type
text string
errorMapping Record‹string, ErrorType

Returns: boolean


# isEscapeToken

isEscapeToken(token: RegExpExecArray): boolean

Defined in src/format/parser.ts:131 (opens new window)

Parameters:

Name Type
token RegExpExecArray

Returns: boolean


# isFormula

isFormula(text: string): boolean

Defined in src/CellContentParser.ts:77 (opens new window)

Checks whether string looks like formula or not.

Parameters:

Name Type Description
text string formula

Returns: boolean


# isNonnegativeInteger

isNonnegativeInteger(x: number): boolean

Defined in src/CrudOperations.ts:651 (opens new window)

Parameters:

Name Type
x number

Returns: boolean


# isPositiveInteger

isPositiveInteger(x: number): boolean

Defined in src/CrudOperations.ts:647 (opens new window)

Parameters:

Name Type
x number

Returns: boolean


# isRowOrColumnRange

isRowOrColumnRange(leftCorner: SimpleCellAddress, width: number, height: number): boolean

Defined in src/Operations.ts:980 (opens new window)

Parameters:

Name Type
leftCorner SimpleCellAddress
width number
height number

Returns: boolean


# isSimpleCellAddress

isSimpleCellAddress(obj: any): obj is SimpleCellAddress

Defined in src/Cell.ts:202 (opens new window)

Parameters:

Name Type
obj any

Returns: obj is SimpleCellAddress


# isSimpleCellRange

isSimpleCellRange(obj: any): obj is SimpleCellRange

Defined in src/AbsoluteCellRange.ts:29 (opens new window)

Parameters:

Name Type
obj any

Returns: obj is SimpleCellRange


# matchDateFormat

matchDateFormat(str: string): RegExpExecArray[]

Defined in src/format/parser.ts:39 (opens new window)

Parameters:

Name Type
str string

Returns: RegExpExecArray[]


# matchNumberFormat

matchNumberFormat(str: string): RegExpExecArray[]

Defined in src/format/parser.ts:55 (opens new window)

Parameters:

Name Type
str string

Returns: RegExpExecArray[]


# movedSimpleCellAddress Const

movedSimpleCellAddress(address: SimpleCellAddress, toSheet: number, toRight: number, toBottom: number): SimpleCellAddress

Defined in src/Cell.ts:196 (opens new window)

Parameters:

Name Type
address SimpleCellAddress
toSheet number
toRight number
toBottom number

Returns: SimpleCellAddress


# normalizeAddedIndexes

normalizeAddedIndexes(indexes: ColumnRowIndex[]): ColumnRowIndex[]

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

Parameters:

Name Type
indexes ColumnRowIndex[]

Returns: ColumnRowIndex[]


# normalizeRemovedIndexes

normalizeRemovedIndexes(indexes: ColumnRowIndex[]): ColumnRowIndex[]

Defined in src/Operations.ts:917 (opens new window)

Parameters:

Name Type
indexes ColumnRowIndex[]

Returns: ColumnRowIndex[]


# numberFormat

numberFormat(tokens: FormatToken[], value: number): RawScalarValue

Defined in src/format/format.ts:49 (opens new window)

Parameters:

Name Type
tokens FormatToken[]
value number

Returns: RawScalarValue


# numberToSimpleTime

numberToSimpleTime(arg: number): SimpleTime

Defined in src/DateTimeHelper.ts:304 (opens new window)

Parameters:

Name Type
arg number

Returns: SimpleTime


# objectDestroy

objectDestroy(object: any): void

Defined in src/Destroy.ts:6 (opens new window)

license Copyright (c) 2022 Handsoncode. All rights reserved.

Parameters:

Name Type
object any

Returns: void


# offsetMonth

offsetMonth(date: SimpleDate, offset: number): SimpleDate

Defined in src/DateTimeHelper.ts:286 (opens new window)

Parameters:

Name Type
date SimpleDate
offset number

Returns: SimpleDate


# padLeft

padLeft(number: number | string, size: number): string

Defined in src/format/format.ts:29 (opens new window)

Parameters:

Name Type
number number | string
size number

Returns: string


# padRight

padRight(number: number | string, size: number): string

Defined in src/format/format.ts:37 (opens new window)

Parameters:

Name Type
number number | string
size number

Returns: string


# parse

parse(str: string): FormatExpression

Defined in src/format/parser.ts:121 (opens new window)

Parameters:

Name Type
str string

Returns: FormatExpression


# parseForDateTimeFormat

parseForDateTimeFormat(str: string): MaybeFormatExpression

Defined in src/format/parser.ts:96 (opens new window)

Parameters:

Name Type
str string

Returns: MaybeFormatExpression


# parseForNumberFormat

parseForNumberFormat(str: string): MaybeFormatExpression

Defined in src/format/parser.ts:109 (opens new window)

Parameters:

Name Type
str string

Returns: MaybeFormatExpression


# postMortem

postMortem(method: any): (Anonymous function)

Defined in src/Destroy.ts:16 (opens new window)

Parameters:

Name Type
method any

Returns: (Anonymous function)


# replacer

replacer(key: any, val: any): any

Defined in src/errors.ts:134 (opens new window)

Parameters:

Name Type
key any
val any

Returns: any


# roundToEpsilon

roundToEpsilon(arg: number, epsilon: number): number

Defined in src/DateTimeHelper.ts:299 (opens new window)

Parameters:

Name Type Default
arg number -
epsilon number 1

Returns: number


# roundToNearestSecond

roundToNearestSecond(arg: number): number

Defined in src/DateTimeHelper.ts:295 (opens new window)

Parameters:

Name Type
arg number

Returns: number


# simpleCellAddress Const

simpleCellAddress(sheet: number, col: number, row: number): SimpleCellAddress

Defined in src/Cell.ts:194 (opens new window)

Parameters:

Name Type
sheet number
col number
row number

Returns: SimpleCellAddress


# simpleCellRange Const

simpleCellRange(start: SimpleCellAddress, end: SimpleCellAddress): object

Defined in src/AbsoluteCellRange.ts:37 (opens new window)

Parameters:

Name Type
start SimpleCellAddress
end SimpleCellAddress

Returns: object


# simpleColumnAddress Const

simpleColumnAddress(sheet: number, col: number): SimpleColumnAddress

Defined in src/Cell.ts:184 (opens new window)

Parameters:

Name Type
sheet number
col number

Returns: SimpleColumnAddress


# simpleRowAddress Const

simpleRowAddress(sheet: number, row: number): SimpleRowAddress

Defined in src/Cell.ts:175 (opens new window)

Parameters:

Name Type
sheet number
row number

Returns: SimpleRowAddress


# split

splitT›(iterable: IterableIterator‹T›): object

Defined in src/generatorUtils.ts:11 (opens new window)

Type parameters:

T

Parameters:

Name Type
iterable IterableIterator‹T›

Returns: object

  • rest: IterableIterator‹T›

  • value? : T


# timeToNumber

timeToNumber(time: SimpleTime): number

Defined in src/DateTimeHelper.ts:315 (opens new window)

Parameters:

Name Type
time SimpleTime

Returns: number


# toBasisEU

toBasisEU(date: SimpleDate): SimpleDate

Defined in src/DateTimeHelper.ts:319 (opens new window)

Parameters:

Name Type
date SimpleDate

Returns: SimpleDate


# truncateDayInMonth

truncateDayInMonth(date: SimpleDate): SimpleDate

Defined in src/DateTimeHelper.ts:291 (opens new window)

Parameters:

Name Type
date SimpleDate

Returns: SimpleDate


# validateArgToType

validateArgToType(inputValue: any, expectedType: string, paramName: string): void

Defined in src/ArgumentSanitization.ts:80 (opens new window)

Parameters:

Name Type
inputValue any
expectedType string
paramName string

Returns: void


# validateAsSheet

validateAsSheet(sheet: Sheet): void

Defined in src/Sheet.ts:33 (opens new window)

Parameters:

Name Type
sheet Sheet

Returns: void


# validateNumberToBeAtLeast

validateNumberToBeAtLeast(value: number, paramName: string, minimum: number): void

Defined in src/ArgumentSanitization.ts:33 (opens new window)

Parameters:

Name Type
value number
paramName string
minimum number

Returns: void


# validateNumberToBeAtMost

validateNumberToBeAtMost(value: number, paramName: string, maximum: number): void

Defined in src/ArgumentSanitization.ts:39 (opens new window)

Parameters:

Name Type
value number
paramName string
maximum number

Returns: void

# Object literals

# CellValueDetailedType Const

#CellValueDetailedType: object

Defined in src/Cell.ts:95 (opens new window)


# CellValueType Const

#CellValueType: object

Defined in src/Cell.ts:92 (opens new window)


# consoleMessages Const

#consoleMessages: object

Defined in src/helpers/licenseKeyValidator.ts:36 (opens new window)

List of all not valid messages which may occur.

# expired

expired(__namedParameters: object): string

Defined in src/helpers/licenseKeyValidator.ts:38 (opens new window)

Parameters:

__namedParameters: object

Name Type
keyValidityDate string

Returns: string

# invalid

invalid(): string

Defined in src/helpers/licenseKeyValidator.ts:37 (opens new window)

Returns: string

# missing

missing(): string

Defined in src/helpers/licenseKeyValidator.ts:40 (opens new window)

Returns: string


# maxDate Const

#maxDate: object

Defined in src/DateTimeHelper.ts:51 (opens new window)

# day

day: number = 31

Defined in src/DateTimeHelper.ts:51 (opens new window)

# month

month: number = 12

Defined in src/DateTimeHelper.ts:51 (opens new window)

# year

year: number = 9999

Defined in src/DateTimeHelper.ts:51 (opens new window)