# DetailedCellError

## Constructors

### constructor 

\+ **new DetailedCellError**(`error`: [CellError](cellerror.md), `value`: string, `address?`: undefined | string): *[DetailedCellError](detailedcellerror.md)*

*Defined in [hyperformula/src/CellValue.ts:67](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L67)*

**Parameters:**

Name | Type |
------ | ------ |
`error` | [CellError](cellerror.md) |
`value` | string |
`address?` | undefined | string |

**Returns:** *[DetailedCellError](detailedcellerror.md)*

## Properties

### address

• **address**? : *undefined | string*

*Defined in [hyperformula/src/CellValue.ts:72](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L72)*

___

### argumentIndex

• **argumentIndex**? : *undefined | number*

*Defined in [hyperformula/src/CellValue.ts:67](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L67)*

The zero-based index of the argument that was rejected, when `originFunction` names a
function whose own argument coercion produced this error.

The index counts the arguments AS WRITTEN in the formula. For a function that accepts
ranges, a range is one argument however many cells it covers, so `=AND(A1:A100,"x")`
reports `1` for `"x"` — the index describes the formula, not the data behind it.

`undefined` whenever the error was not a coercion failure on one of the origin
function's own arguments — including when it came from a nested call (its own
`originFunction` already claimed it), when it was propagated from elsewhere, or when
the offending value sat inside a range that the function IGNORES
(`=AND(A1:A2,TRUE())` over text returns `TRUE`, so there is no error to attribute).

When a function does NOT ignore it — `MULTINOMIAL` coerces every value to a number —
a bad cell inside a range is attributed to the RANGE's own argument slot, since that
is the argument the user wrote: `=MULTINOMIAL(1,A1:A3)` with text in `A3` reports `1`.
The index names the argument to look at, not the cell; the address of the offending
cell is not part of this field.

___

### hasMessage

• **hasMessage**: *boolean*

*Defined in [hyperformula/src/CellValue.ts:25](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L25)*

Whether the underlying error carried a message at all.

`message` collapses "no message" and "an empty message" into `''`; this flag
keeps them apart for consumers that need to know whether a cause was stated.
Errors the engine raises while evaluating a formula always carry a message. A
`false` here means nobody stated a cause: a custom function that did not supply
one, or an error value a user typed straight into a cell, where the cause is the
typing itself and `originFunction` says so.

___

### message

• **message**: *string*

*Defined in [hyperformula/src/CellValue.ts:13](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L13)*

___

### originFunction

• **originFunction**? : *undefined | string*

*Defined in [hyperformula/src/CellValue.ts:45](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L45)*

What produced this error.

Usually the function or operator that rejected a value, e.g. `'SQRT'` or `'divide'`; an
operator is named after the arithmetic helper it dispatches to. An error that exists
before any function reads it names what built it instead: `'reference'` for a reference
that cannot be resolved, `'removed reference'` for one destroyed by removing rows or
columns, `'parser'` for a formula that could not be parsed, `'user input'` for an error
value typed into a cell, `'literal'` for one written into a formula, and
`'array literal'` for an array literal whose rows differ in length.

First occurrence wins, so a function that only read the error never replaces that:
`=SUM(SQRT(-1))` reports `'SQRT'`, and `=SUM(A2:A99999999999)` reports `'reference'`.
An error inside an array result names the operation that built the array.

`undefined` for `#SPILL!` and `#CYCLE!`, which arise from the layout of a sheet rather
than from evaluating a value.

___

### type

• **type**: *[ErrorType](hyperformulans.md#static-errortype)*

*Defined in [hyperformula/src/CellValue.ts:12](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L12)*

___

### value

• **value**: *string*

*Defined in [hyperformula/src/CellValue.ts:71](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L71)*

## Methods

### toString 

▸ **toString**(): *string*

*Defined in [hyperformula/src/CellValue.ts:81](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L81)*

**Returns:** *string*

___

### valueOf 

▸ **valueOf**(): *string*

*Defined in [hyperformula/src/CellValue.ts:85](https://github.com/handsontable/hyperformula/blob/a95916b/hyperformula/src/CellValue.ts#L85)*

**Returns:** *string*