Represents a range of one or more cells.
Constructors
Section titled "Constructors"SpreadsheetCellRange
new SpreadsheetCellRange(firstRow: number, firstColumn: number): SpreadsheetCellRangeReturns SpreadsheetCellRange
Properties
Section titled "Properties"$t: Typeempty
Section titled "empty"empty: SpreadsheetCellRangeAccessors
Section titled "Accessors"firstColumn
Section titled "firstColumn"Returns the index of the first column in the range.
get firstColumn(): numberReturns number
firstRow
Section titled "firstRow"Returns the index of the first row in the range.
get firstRow(): numberReturns number
isEmpty
Section titled "isEmpty"Returns a boolean indicating if the structure represents a valid range.
get isEmpty(): booleanReturns boolean
isSingleCell
Section titled "isSingleCell"Returns a boolean indicating if the range represents a single cell.
get isSingleCell(): booleanReturns boolean
lastColumn
Section titled "lastColumn"Returns the index of the last column in the range.
get lastColumn(): numberReturns number
lastRow
Section titled "lastRow"Returns the index of the last row in the range.
get lastRow(): numberReturns number
Methods
Section titled "Methods"contains
Section titled "contains"Returns a boolean indicating if the specified cell is within the range.
contains(cell: SpreadsheetCell): booleanParameters
- cell:
SpreadsheetCellThe cell to evaluate
Returns boolean
equals
Section titled "equals"Compares the value of this SheetCellRange instance to the specified [[SpreadsheetCellRange]].
equals(other: SpreadsheetCellRange): booleanParameters
- other:
SpreadsheetCellRangeThe instance of the [[SpreadsheetCellRange]] to compare
Returns boolean
equals1
Section titled "equals1"Compares the specified [[SpreadsheetCellRange]] to this instance's values.
equals1(obj: any): booleanParameters
- obj:
anyThe object to compare to the current instance
Returns boolean
getHashCode
Section titled "getHashCode"Returns a hash value for the [[SpreadsheetCellRange]]
getHashCode(): numberReturns number
intersect
Section titled "intersect"Returns a range that represents the common area within the current and specified range.
intersect(range: SpreadsheetCellRange): SpreadsheetCellRangeParameters
- range:
SpreadsheetCellRangeThe range to intersect with.
Returns SpreadsheetCellRange
intersectsWith
Section titled "intersectsWith"Returns a boolean indicating if the current and specified range overlap.
intersectsWith(range: SpreadsheetCellRange): booleanParameters
- range:
SpreadsheetCellRangeThe range to compare with.
Returns boolean
toString
Section titled "toString"Returns a string representation of the [[SpreadsheetCellRange]]
toString(): stringReturns string
union
Section titled "union"Returns a range that contains the contains the current and specified range.
union(range: SpreadsheetCellRange): SpreadsheetCellRangeParameters
- range:
SpreadsheetCellRangeThe range to combine with.
Returns SpreadsheetCellRange
staticInit
Section titled "staticInit"staticInit(): void