Class ArrayFormula

Represents an array formula for a group of cells.

Array formulas are similar to regular formula in that they have the same grammar. However, array formulas must be set on a single region of cells only. When the array formula is applied to a region of cells, each cell's Formula property will be the array formula. The Value of each cell cannot be changed unless [[clearCellRange]] is called on the array formula or another value is applied to a region of cells which completely contains the array formula's region.

Because the array formula stores the region of the cells to which it is applied in the [[cellRange]] property, the array formula can only be applied to one region of cells.

Array formulas are created through Microsoft Excel by selecting a region of cells, entering a formula for that range, and pressing Ctrl+Shift+Enter. This causes the formula of each cell in the region to appear as follows: {=Formula}.

See the Microsoft Excel documentation for more information on array formulas.

Hierarchy

Hierarchy (view full)

Formula
- ArrayFormula

Implements

IRegionBlockingValue

Constructors

constructor

new ArrayFormula(a, b): ArrayFormula
Overrides Formula.constructor
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20696
Parameters
- a: number
- b: number
Returns ArrayFormula
new ArrayFormula(a, b): ArrayFormula
Overrides Formula.constructor
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20697
Parameters
- a: number
- b: ArrayFormula
Returns ArrayFormula
new ArrayFormula(a, ..._rest): ArrayFormula
Overrides Formula.constructor
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20698
Parameters
- a: number
- Rest ..._rest: any[]
Returns ArrayFormula

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Accessors

cellRange

get cellRange(): WorksheetRegion
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20962
Gets the cells to which the array formula is applied.

If this is null, the formula has not yet been applied.
The cells to which the array formula is applied.
Returns WorksheetRegion

Methods

applyTo

applyTo(regions): void
Inherited from Formula.applyTo
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6549
Applies the formula to all specified regions of cells.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of all cells in all specified regions will return the formula.
Throws
[[ArgumentNullException]] 'regions' is null.

Throws
[[ArgumentException]] 'regions' has a length of 0.

Throws
[[ArgumentException]] Not all regions specified are from the same worksheet.

Throws
[[InvalidOperationException]] One or more regions specified contain array formulas or data tables which extend outside the region.

See
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
Parameters
- regions: WorksheetRegion[]
  The regions of cells to apply the formula to.
Returns void
applyTo(cell): void
Inherited from Formula.applyTo
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6568
Applies the formula to the specified cell.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of the specified cell will return the formula.
Throws
[[ArgumentNullException]] 'cell' is null.

Throws
[[InvalidOperationException]] 'cell' is part of an array formula or data table which is not confined to just the cell.

See
- [[WorksheetCell.value]]
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
- [[WorksheetRegion.applyArrayFormula]]
Parameters
- cell: WorksheetCell
  The cell to apply the formula to.
Returns void
applyTo(region): void
Inherited from Formula.applyTo
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6587
Applies the formula to the specified region of cells.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of all cells in the specified region will return the formula.
Throws
[[ArgumentNullException]] 'region' is null.

Throws
[[InvalidOperationException]] 'region' contains an array formula or data table which extends outside the region.

See
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
- [[WorksheetRegion.applyArrayFormula]]
Parameters
- region: WorksheetRegion
  The region of cells to apply the formula to.
Returns void

clearCellRange

clearCellRange(): void
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20789
Removes this array formula as the formula for the cells to which it was applied.

After this method returns, the [[cellRange]] will be null.
Returns void

equals

equals(other): boolean
Inherited from Formula.equals
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

getHashCode

getHashCode(): number
Inherited from Formula.getHashCode
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:17
Returns number

memberwiseClone

memberwiseClone(): Base
Inherited from Formula.memberwiseClone
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:19
Returns Base

toString

toString(): string
Inherited from Formula.toString
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6512
Converts the formula to a string representation, similar to the string with which it was created. This uses the [[CellReferenceMode]] with which the formula was created to create cell reference strings.

Returns string
toString(cellReferenceMode): string
Inherited from Formula.toString
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6518
Converts the formula to a string representation, similar to the string with which it was created.

Parameters
- cellReferenceMode: CellReferenceMode
  The cell reference mode used to create cell reference strings.
Returns string
toString(cellReferenceMode, culture): string
Inherited from Formula.toString
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6525
Converts the formula to a string representation, similar to the string with which it was created.

Parameters
- cellReferenceMode: CellReferenceMode
  The cell reference mode used to create cell reference strings.
- culture: string | CultureInfo
  The culture used to generate the formula string.
Returns string

`Static` areEqual

areEqual(formulaA, formulaB, cellReferenceMode): boolean
Inherited from Formula.areEqual
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6768
Determines whether two [[Formula]] instances are equal using the specified cell reference mode. This essentially performs a case-insensitive string comparison, ignoring the white space in the formula.

Parameters
- formulaA: Formula
  The first Formula to compare.
- formulaB: Formula
  The second Formula to compare.
- cellReferenceMode: CellReferenceMode
  The cell reference mode to use when comparing the two formulas.
Returns boolean

`Static` compare

compare(item1, item2): number
Inherited from Formula.compare
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1, item2): number
Inherited from Formula.compareSimple
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1, item2): boolean
Inherited from Formula.equalsSimple
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a, b): boolean
Inherited from Formula.equalsStatic
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj): any[]
Inherited from Formula.getArrayOfProperties
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj): any[]
Inherited from Formula.getArrayOfValues
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj): number
Inherited from Formula.getHashCodeStatic
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` parse

parse(value, cellReferenceMode): ArrayFormula
Overrides Formula.parse
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20803
Parses the specified formula value and returns the array formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the array formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the array formula.
Returns ArrayFormula
parse(value, cellReferenceMode, fileFormat): ArrayFormula
Overrides Formula.parse
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20815
Parses the specified formula value and returns the array formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[InvalidEnumArgumentException]] 'fileFormat' is not defined in the [[WorkbookFormat]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the array formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the array formula.
- fileFormat: WorkbookFormat
  The file format to use when parsing the array formula. This will be used to determine certain limits which are format dependant.
Returns ArrayFormula
parse(value, cellReferenceMode, fileFormat, culture): ArrayFormula
Overrides Formula.parse
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20828
Parses the specified formula value and returns the array formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[InvalidEnumArgumentException]] 'fileFormat' is not defined in the [[WorkbookFormat]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the array formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the array formula.
- fileFormat: WorkbookFormat
  The file format to use when parsing the array formula. This will be used to determine certain limits which are format dependant.
- culture: string | CultureInfo
  The culture used to parse the formula.
Returns ArrayFormula
parse(value, cellReferenceMode, culture): ArrayFormula
Overrides Formula.parse
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:20839
Parses the specified formula value and returns the array formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the array formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the array formula.
- culture: string | CultureInfo
  The culture used to parse the formula.
Returns ArrayFormula

`Static` referenceEquals

referenceEquals(a, b): boolean
Inherited from Formula.referenceEquals
- Defined in node_modules/igniteui-webcomponents-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

`Static` staticInit

staticInit(): void
Inherited from Formula.staticInit
- Defined in dist/igniteui-webcomponents-excel/lib/DefaultStyleHelper_combined.d.ts:6500
Returns void

Class ArrayFormula

Hierarchy

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

a: number

b: number

Returns ArrayFormula

Parameters

a: number

b: ArrayFormula

Returns ArrayFormula

Parameters

a: number

Rest ..._rest: any[]

Returns ArrayFormula

Properties

$type

Static $t

Static nextHashCode

Accessors

cellRange

Returns WorksheetRegion

Methods

applyTo

Throws

Throws

Throws

Throws

See

Parameters

regions: WorksheetRegion[]

Returns void

Throws

Throws

See

Parameters

cell: WorksheetCell

Returns void

Throws

Throws

See

Parameters

region: WorksheetRegion

Returns void

clearCellRange

Returns void

equals

Parameters

other: any

Returns boolean

getHashCode

Returns number

memberwiseClone

Returns Base

toString

Returns string

Parameters

cellReferenceMode: CellReferenceMode

Returns string

Parameters

cellReferenceMode: CellReferenceMode

culture: string | CultureInfo

Returns string

Static areEqual

Parameters

formulaA: Formula

formulaB: Formula

cellReferenceMode: CellReferenceMode

Returns boolean

Static compare

Parameters

item1: any

item2: any

`Static` $t

`Static` nextHashCode

`Static` areEqual

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` parse

`Static` referenceEquals

`Static` staticInit