Represents a rectangular region of cells on a worksheet.

Constructors

Section titled "Constructors"

WorksheetRegion

new WorksheetRegion(worksheet: Worksheet, firstRow: number, firstColumn: number, lastRow: number, lastColumn: number): WorksheetRegion

Returns WorksheetRegion

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

firstColumn

Section titled "firstColumn"

Gets the index of the first column in the region. The index of the first column in the region.

get firstColumn(): number

Returns number

firstRow

Section titled "firstRow"

Gets the index of the first row in the region. The index of the first row in the region.

get firstRow(): number

Returns number

lastColumn

Section titled "lastColumn"

Gets the index of the last column in the region. The index of the last column in the region.

get lastColumn(): number

Returns number

lastRow

Section titled "lastRow"

Gets the index of the last row in the region. The index of the last row in the region.

get lastRow(): number

Returns number

worksheet

Section titled "worksheet"

Gets the worksheet on which the region resides. The worksheet on which the region resides or null if the region has been shifted off the worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

applyArrayFormula

Section titled "applyArrayFormula"

Applies a array formula to the region of cells.

applyArrayFormula(value: string): void

Parameters

  • value: string

    The array formula to parse and apply to the region.

Returns void

applyFormula

Section titled "applyFormula"

Applies a formula to the region of cells.

applyFormula(value: string): void

Parameters

  • value: string

    The formula to parse and apply to the region.

Returns void

equals

Section titled "equals"

Determines whether the specified value equals this [[WorksheetRegion]].

equals(obj: any): boolean

Parameters

  • obj: any

    The value to test for equality.

Returns boolean

formatAsTable

Section titled "formatAsTable"

Formats the region as a table and adds an associated [[WorksheetTable]] to the [[Worksheet.tables]] collection.

formatAsTable(tableHasHeaders: boolean): WorksheetTable

Parameters

  • tableHasHeaders: boolean

    A value which indicates whether the top row of the region contains the headers for the table.

Returns WorksheetTable

getBoundsInTwips

Section titled "getBoundsInTwips"

Gets the bounds of the region in twips (1/20th of a point).

getBoundsInTwips(): IgRect

Returns IgRect

getEnumerator

Section titled "getEnumerator" 
getEnumerator(): IEnumerator$1<WorksheetCell>

Returns IEnumerator$1<WorksheetCell>

getHashCode

Section titled "getHashCode"

Gtes the hash code for the [[WorksheetRegion]].

getHashCode(): number

Returns number

toString

Section titled "toString"

Gets the string representation of the range of cells in the region.

toString(): string

Returns string