Methods

getEndColumn()

The end column of the area.

getEndRow()

The end row of the area.

getExternalFileName()

Get the external file name if this is an external reference.

getSheetName()

Indicates which sheet this reference is in.

getStartColumn()

The start column of the area.

getStartRow()

The start row of the area.

getValue(rowOffset, colOffset) → Object

Gets cell value with given offset from the top-left of this area.

Parameters

Name Type Optional Description

rowOffset

Number

 

row offset from the start row of this area

colOffset

Number

 

column offset from the start row of this area

Returns

Object "#REF!" if this area is invalid; "#N/A" if given offset out of this area; Otherwise return the cell value at given position.

getValue(rowOffset, colOffset, calculateFormulas) → Object

Gets cell value with given offset from the top-left of this area.

Parameters

Name Type Optional Description

rowOffset

Number

 

row offset from the start row of this area

colOffset

Number

 

column offset from the start row of this area

calculateFormulas

boolean

 

Whether calculate it recursively if the specified reference is formula

Returns

Object "#REF!" if this area is invalid; "#N/A" if given offset out of this area; Otherwise return the cell value at given position.

getValues() → Object

Gets cell values in this area.

Returns

Object If this area is invalid, "#REF!" will be returned; If this area is one single cell, then return the cell value object; Otherwise return one 2D array for all values in this area.

getValues(calculateFormulas) → Object

Gets cell values in this area.

Parameter

Name Type Optional Description

calculateFormulas

boolean

 

In this range, if there are some formulas that have not been calculated, this flag denotes whether those formulas should be calculated recursively

Returns

Object If this area is invalid, "#REF!" will be returned; If this area is one single cell, then return the cell value object; Otherwise return one 2D array for all values in this area.

isArea()

Indicates whether this is an area. If this is not an area, only StartRow and StartColumn effect.

isEntireColumn()

Indicates whether this area contains all rows(entire column).

isEntireRow()

Indicates whether this area contains all columns(entire row).

Indicates whether this is an external link.

toString() → String

Returns the reference address of this area. Generally it is the address of the reference which may be used in formula, such as "Sheet1!A1:C3".

Returns

String the reference address of this area.