ReferredArea

ReferredArea class

Represents a referred area by the formula.

class ReferredArea;

Properties

Property	Type	Description
isExternalLink	boolean	Readonly. Indicates whether this is an external link.
externalFileName	string	Readonly. Get the external file name if this is an external reference.
sheetName	string	Readonly. Indicates which sheet this reference is in.
sheetNames	string[]	Readonly. Names of all the worksheets this instance references to.
isEntireRow	boolean	Readonly. Indicates whether this area contains all columns(entire row).
isEntireColumn	boolean	Readonly. Indicates whether this area contains all rows(entire column).
isArea	boolean	Readonly. Indicates whether this is an area.
endColumn	number	Readonly. The end column of the area.
startColumn	number	Readonly. The start column of the area.
endRow	number	Readonly. The end row of the area.
startRow	number	Readonly. The start row of the area.

Methods

Method	Description
isExternalLink()	@deprecated. Please use the ‘isExternalLink’ property instead. Indicates whether this is an external link.
getExternalFileName()	@deprecated. Please use the ’externalFileName’ property instead. Get the external file name if this is an external reference.
getSheetName()	@deprecated. Please use the ‘sheetName’ property instead. Indicates which sheet this reference is in.
getSheetNames()	@deprecated. Please use the ‘sheetNames’ property instead. Names of all the worksheets this instance references to.
isEntireRow()	@deprecated. Please use the ‘isEntireRow’ property instead. Indicates whether this area contains all columns(entire row).
isEntireColumn()	@deprecated. Please use the ‘isEntireColumn’ property instead. Indicates whether this area contains all rows(entire column).
isArea()	@deprecated. Please use the ‘isArea’ property instead. Indicates whether this is an area.
getEndColumn()	@deprecated. Please use the ’endColumn’ property instead. The end column of the area.
getStartColumn()	@deprecated. Please use the ‘startColumn’ property instead. The start column of the area.
getEndRow()	@deprecated. Please use the ’endRow’ property instead. The end row of the area.
getStartRow()	@deprecated. Please use the ‘startRow’ property instead. The start row of the area.
getValues()	Gets cell values in this area.
getValues(boolean)	Gets cell values in this area.
getValue(number, number)	Gets cell value with given offset from the top-left of this area.
getValue(number, number, boolean)	Gets cell value with given offset from the top-left of this area.
isNull()	Checks whether the implementation object is null.
toString()	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”.

isExternalLink

Readonly. Indicates whether this is an external link.

isExternalLink : boolean;

externalFileName

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

externalFileName : string;

sheetName

Readonly. Indicates which sheet this reference is in.

sheetName : string;

Remarks

If it references to multiple worksheets, the returned value is just like the range expression in the formula. For example “Sheet1:Sheet3” for the reference in formula “=SUM(Sheet1:Sheet3!$A$1:$B$2)”.

sheetNames

Readonly. Names of all the worksheets this instance references to.

sheetNames : string[];

isEntireRow

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

isEntireRow : boolean;

isEntireColumn

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

isEntireColumn : boolean;

isArea

Readonly. Indicates whether this is an area.

isArea : boolean;

Remarks

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

endColumn

Readonly. The end column of the area.

endColumn : number;

startColumn

Readonly. The start column of the area.

startColumn : number;

endRow

Readonly. The end row of the area.

endRow : number;

startRow

Readonly. The start row of the area.

startRow : number;

isExternalLink()

@deprecated. Please use the ‘isExternalLink’ property instead. Indicates whether this is an external link.

isExternalLink() : boolean;

getExternalFileName()

@deprecated. Please use the ’externalFileName’ property instead. Get the external file name if this is an external reference.

getExternalFileName() : string;

getSheetName()

@deprecated. Please use the ‘sheetName’ property instead. Indicates which sheet this reference is in.

getSheetName() : string;

Remarks

getSheetNames()

@deprecated. Please use the ‘sheetNames’ property instead. Names of all the worksheets this instance references to.

getSheetNames() : string[];

Returns

string[]

isEntireRow()

@deprecated. Please use the ‘isEntireRow’ property instead. Indicates whether this area contains all columns(entire row).

isEntireRow() : boolean;

isEntireColumn()

@deprecated. Please use the ‘isEntireColumn’ property instead. Indicates whether this area contains all rows(entire column).

isEntireColumn() : boolean;

isArea()

@deprecated. Please use the ‘isArea’ property instead. Indicates whether this is an area.

isArea() : boolean;

Remarks

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

getEndColumn()

@deprecated. Please use the ’endColumn’ property instead. The end column of the area.

getEndColumn() : number;

getStartColumn()

@deprecated. Please use the ‘startColumn’ property instead. The start column of the area.

getStartColumn() : number;

getEndRow()

@deprecated. Please use the ’endRow’ property instead. The end row of the area.

getEndRow() : number;

getStartRow()

@deprecated. Please use the ‘startRow’ property instead. The start row of the area.

getStartRow() : number;

getValues()

Gets cell values in this area.

getValues() : Object;

Returns

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(boolean)

Gets cell values in this area.

getValues(calculateFormulas: boolean) : Object;

Parameters:

Parameter	Type	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

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.

getValue(number, number)

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

getValue(rowOffset: number, colOffset: number) : Object;

Parameters:

Parameter	Type	Description
rowOffset	number	row offset from the start row of this area
colOffset	number	column offset from the start row of this area

Returns

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

getValue(number, number, boolean)

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

getValue(rowOffset: number, colOffset: number, calculateFormulas: boolean) : Object;

Parameters:

Parameter	Type	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

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

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

toString()

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”.

toString() : string;

Returns

the reference address of this area.