HyperFormula (v3.4.0)

View as Markdown

# ErrorMessage Class

This is a class for detailed error messages across HyperFormula.

# Properties

# ArrayDimensions Static

▪ ArrayDimensions: string = "Array dimensions are not compatible."

Defined in src/error-message.ts:14 (opens new window)

# BadCriterion Static

▪ BadCriterion: string = "Incorrect criterion."

Defined in src/error-message.ts:18 (opens new window)

# BadMode Static

▪ BadMode: string = "Mode not recognized."

Defined in src/error-message.ts:26 (opens new window)

# BadRef Static

▪ BadRef: string = "Address is not correct."

Defined in src/error-message.ts:39 (opens new window)

# BitshiftLong Static

▪ BitshiftLong: string = "Result of bitshift is too long."

Defined in src/error-message.ts:58 (opens new window)

# CellRangeExpected Static

▪ CellRangeExpected: string = "Cell range expected."

Defined in src/error-message.ts:20 (opens new window)

# CellRefExpected Static

▪ CellRefExpected: string = "Cell reference expected."

Defined in src/error-message.ts:37 (opens new window)

# CharacterCodeBounds Static

▪ CharacterCodeBounds: string = "Character code out of bounds."

Defined in src/error-message.ts:67 (opens new window)

# ComplexNumberExpected Static

▪ ComplexNumberExpected: string = "Complex number expected."

Defined in src/error-message.ts:73 (opens new window)

# DateBounds Static

▪ DateBounds: string = "Date outside of bounds."

Defined in src/error-message.ts:27 (opens new window)

# DistinctSigns Static

▪ DistinctSigns: string = "Distinct signs."

Defined in src/error-message.ts:10 (opens new window)

# EmptyArg Static

▪ EmptyArg: string = "Empty function argument."

Defined in src/error-message.ts:12 (opens new window)

# EmptyArray Static

▪ EmptyArray: string = "Empty array not allowed."

Defined in src/error-message.ts:13 (opens new window)

# EmptyRange Static

▪ EmptyRange: string = "Empty range not allowed."

Defined in src/error-message.ts:38 (opens new window)

# EmptyString Static

▪ EmptyString: string = "Empty-string argument not allowed."

Defined in src/error-message.ts:59 (opens new window)

# EndStartPeriod Static

▪ EndStartPeriod: string = "End period needs to be at least start period."

Defined in src/error-message.ts:36 (opens new window)

# EqualLength Static

▪ EqualLength: string = "Ranges need to be of equal length."

Defined in src/error-message.ts:31 (opens new window)

# Formula Static

▪ Formula: string = "Expected formula."

Defined in src/error-message.ts:52 (opens new window)

# IncorrectDateTime Static

▪ IncorrectDateTime: string = "String does not represent correct DateTime."

Defined in src/error-message.ts:66 (opens new window)

# IndexBounds Static

▪ IndexBounds: string = "Index out of bounds."

Defined in src/error-message.ts:50 (opens new window)

# IndexLarge Static

▪ IndexLarge: string = "Index too large."

Defined in src/error-message.ts:51 (opens new window)

# IntegerExpected Static

▪ IntegerExpected: string = "Value needs to be an integer."

Defined in src/error-message.ts:25 (opens new window)

# InvalidDate Static

▪ InvalidDate: string = "Invalid date."

Defined in src/error-message.ts:57 (opens new window)

# InvalidRoman Static

▪ InvalidRoman: string = "Invalid roman numeral."

Defined in src/error-message.ts:71 (opens new window)

# LengthBounds Static

▪ LengthBounds: string = "Length out of bounds."

Defined in src/error-message.ts:60 (opens new window)

# LessThanOne Static

▪ LessThanOne: string = "Argument cannot be less than 1."

Defined in src/error-message.ts:69 (opens new window)

# NaN Static

▪ NaN: string = "NaN or infinite value encountered."

Defined in src/error-message.ts:30 (opens new window)

# Negative Static

▪ Negative: string = "Value cannot be negative."

Defined in src/error-message.ts:32 (opens new window)

# NegativeCount Static

▪ NegativeCount: string = "Count cannot be negative."

Defined in src/error-message.ts:53 (opens new window)

# NegativeLength Static

▪ NegativeLength: string = "Length cannot be negative."

Defined in src/error-message.ts:45 (opens new window)

# NegativeTime Static

▪ NegativeTime: string = "Time cannot be negative."

Defined in src/error-message.ts:61 (opens new window)

# NoConditionMet Static

▪ NoConditionMet: string = "None of the conditions were met."

Defined in src/error-message.ts:63 (opens new window)

# NoDefault Static

▪ NoDefault: string = "No default option."

Defined in src/error-message.ts:62 (opens new window)

# NoSpaceForArrayResult Static

▪ NoSpaceForArrayResult: string = "No space for array result."

Defined in src/error-message.ts:15 (opens new window)

# NonZero Static

▪ NonZero: string = "Argument cannot be 0."

Defined in src/error-message.ts:68 (opens new window)

# NotBinary Static

▪ NotBinary: string = "String does not represent a binary number."

Defined in src/error-message.ts:33 (opens new window)

# NotHex Static

▪ NotHex: string = "String does not represent a hexadecimal number."

Defined in src/error-message.ts:35 (opens new window)

# NotOctal Static

▪ NotOctal: string = "String does not represent an octal number."

Defined in src/error-message.ts:34 (opens new window)

# NumberCoercion Static

▪ NumberCoercion: string = "Value cannot be coerced to number."

Defined in src/error-message.ts:23 (opens new window)

# NumberExpected Static

▪ NumberExpected: string = "Number argument expected."

Defined in src/error-message.ts:24 (opens new window)

# NumberRange Static

▪ NumberRange: string = "Number-only range expected."

Defined in src/error-message.ts:40 (opens new window)

# OneValue Static

▪ OneValue: string = "Needs at least one value."

Defined in src/error-message.ts:47 (opens new window)

# OutOfSheet Static

▪ OutOfSheet: string = "Resulting reference is out of the sheet."

Defined in src/error-message.ts:28 (opens new window)

# ParseError Static

▪ ParseError: string = "Parsing error."

Defined in src/error-message.ts:54 (opens new window)

# PatternNotFound Static

▪ PatternNotFound: string = "Pattern not found."

Defined in src/error-message.ts:46 (opens new window)

# PeriodLong Static

▪ PeriodLong: string = "Period number cannot exceed life length."

Defined in src/error-message.ts:56 (opens new window)

# RangeManySheets Static

▪ RangeManySheets: string = "Range spans more than one sheet."

Defined in src/error-message.ts:19 (opens new window)

# ResultTooLong Static

▪ ResultTooLong: string = "Result exceeds the maximum allowed length."

Defined in src/error-message.ts:76 (opens new window)

# ScalarExpected Static

▪ ScalarExpected: string = "Cell range not allowed."

Defined in src/error-message.ts:22 (opens new window)

# Selector Static

▪ Selector: string = "Selector cannot exceed the number of arguments."

Defined in src/error-message.ts:64 (opens new window)

# SheetRef Static

▪ SheetRef: string = "Sheet does not exist."

Defined in src/error-message.ts:55 (opens new window)

# ShouldBeIorJ Static

▪ ShouldBeIorJ: string = "Should be 'i' or 'j'."

Defined in src/error-message.ts:74 (opens new window)

# SizeMismatch Static

▪ SizeMismatch: string = "Array dimensions mismatched."

Defined in src/error-message.ts:75 (opens new window)

# StartEndDate Static

▪ StartEndDate: string = "Start date needs to be earlier than end date."

Defined in src/error-message.ts:65 (opens new window)

# ThreeValues Static

▪ ThreeValues: string = "Range needs to contain at least three elements."

Defined in src/error-message.ts:49 (opens new window)

# TwoValues Static

▪ TwoValues: string = "Range needs to contain at least two elements."

Defined in src/error-message.ts:48 (opens new window)

# ValueBaseLarge Static

▪ ValueBaseLarge: string = "Value in base too large."

Defined in src/error-message.ts:42 (opens new window)

# ValueBaseLong Static

▪ ValueBaseLong: string = "Value in base too long."

Defined in src/error-message.ts:44 (opens new window)

# ValueBaseSmall Static

▪ ValueBaseSmall: string = "Value in base too small."

Defined in src/error-message.ts:43 (opens new window)

# ValueLarge Static

▪ ValueLarge: string = "Value too large."

Defined in src/error-message.ts:17 (opens new window)

# ValueNotFound Static

▪ ValueNotFound: string = "Value not found."

Defined in src/error-message.ts:41 (opens new window)

# ValueSmall Static

▪ ValueSmall: string = "Value too small."

Defined in src/error-message.ts:16 (opens new window)

# WeekendString Static

▪ WeekendString: string = "Incorrect weekend bitmask string."

Defined in src/error-message.ts:70 (opens new window)

# WrongArgNumber Static

▪ WrongArgNumber: string = "Wrong number of arguments."

Defined in src/error-message.ts:11 (opens new window)

# WrongDimension Static

▪ WrongDimension: string = "Wrong range dimension."

Defined in src/error-message.ts:21 (opens new window)

# WrongOrder Static

▪ WrongOrder: string = "Wrong order of values."

Defined in src/error-message.ts:72 (opens new window)

# WrongType Static

▪ WrongType: string = "Wrong type of argument."

Defined in src/error-message.ts:29 (opens new window)

# Methods

# FunctionName Static

▸ FunctionName(arg: string): string

Defined in src/error-message.ts:77 (opens new window)

Parameters:

Name Type
arg string

Returns: string

# LicenseKey Static

▸ LicenseKey(arg: string): string

Defined in src/error-message.ts:79 (opens new window)

Parameters:

Name Type
arg string

Returns: string

# NamedExpressionName Static

▸ NamedExpressionName(arg: string): string

Defined in src/error-message.ts:78 (opens new window)

Parameters:

Name Type
arg string

Returns: string