Class SpreadsheetCellRange

Represents a range of one or more cells.

Hierarchy

ValueType
- SpreadsheetCellRange

Implements

IEquatable$1<SpreadsheetCellRange>

Constructors

constructor

new SpreadsheetCellRange(firstRow: number, firstColumn: number): SpreadsheetCellRange
Overrides ValueType.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:9
Parameters
- firstRow: number
- firstColumn: number
Returns SpreadsheetCellRange
new SpreadsheetCellRange(firstRow: number, firstColumn: number, lastRow: number, lastColumn: number): SpreadsheetCellRange
Overrides ValueType.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:10
Parameters
- firstRow: number
- firstColumn: number
- lastRow: number
- lastColumn: number
Returns SpreadsheetCellRange
new SpreadsheetCellRange(address: string): SpreadsheetCellRange
Overrides ValueType.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:11
Parameters
- address: string
Returns SpreadsheetCellRange
new SpreadsheetCellRange(): SpreadsheetCellRange
Overrides ValueType.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:12
Returns SpreadsheetCellRange
new SpreadsheetCellRange(..._rest: any[]): SpreadsheetCellRange
Overrides ValueType.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:13
Parameters
- Rest ..._rest: any[]
Returns SpreadsheetCellRange

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` empty

empty: SpreadsheetCellRange

`Static` nextHashCode

nextHashCode: number

Accessors

firstColumn

get firstColumn(): number
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:62
Returns the index of the first column in the range.

Returns number

firstRow

get firstRow(): number
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:66
Returns the index of the first row in the range.

Returns number

isEmpty

get isEmpty(): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:78
Returns a boolean indicating if the structure represents a valid range.

Returns boolean

isSingleCell

get isSingleCell(): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:74
Returns a boolean indicating if the range represents a single cell.

Returns boolean

lastColumn

get lastColumn(): number
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:82
Returns the index of the last column in the range.

Returns number

lastRow

get lastRow(): number
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:86
Returns the index of the last row in the range.

Returns number

Methods

contains

contains(cell: SpreadsheetCell): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:104
Returns a boolean indicating if the specified cell is within the range.

Returns
Returns true if the cell is within the range; otherwise false.

Parameters
- cell: SpreadsheetCell
  
  The cell to evaluate
Returns boolean
contains(range: SpreadsheetCellRange): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:110
Returns a boolean indicating if the specified range is completely within this range.

Returns
Returns true if the range is within this range; otherwise false.

Parameters
- range: SpreadsheetCellRange
  
  The range to evaluate
Returns boolean
contains(row: number, column: number): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:117
Returns a boolean indicating if the specified cell is within the range.

Returns
Returns true if the cell is within the range; otherwise false.

Parameters
- row: number
  
  The row to evaluate
- column: number
  
  The column to evaluate
Returns boolean

equals

equals(other: SpreadsheetCellRange): boolean
Implementation of IEquatable$1.equals

Overrides ValueType.equals
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:26
Compares the value of this SheetCellRange instance to the specified SpreadsheetCellRange.

Returns
True if the specified SheetCellRange has the same firstRow, lastRow, firstColumn and lastColumn; otherwise false.

Parameters
- other: SpreadsheetCellRange
  
  The instance of the SpreadsheetCellRange to compare
Returns boolean
equals(obj: any): boolean
Implementation of IEquatable$1.equals

Overrides ValueType.equals
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:32
Compares the specified SpreadsheetCellRange to this instance's values.

Returns
True if the object is a SheetCellRange with the same firstRow, lastRow, firstColumn and lastColumn.

Parameters
- obj: any
  
  The object to compare to the current instance
Returns boolean

equals1

equals1(obj: any): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:38
Compares the specified SpreadsheetCellRange to this instance's values.

Returns
True if the object is a SheetCellRange with the same firstRow, lastRow, firstColumn and lastColumn.

Parameters
- obj: any
  
  The object to compare to the current instance
Returns boolean

getHashCode

getHashCode(): number
Overrides ValueType.getHashCode
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:43
Returns a hash value for the SpreadsheetCellRange

Returns
A hash value for the SheetCellRange

Returns number

intersect

intersect(range: SpreadsheetCellRange): SpreadsheetCellRange
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:135
Returns a range that represents the common area within the current and specified range.

Returns
A range that represents the common area between the current and specified range or SpreadsheetCellRange.empty if there is no overlap.

Parameters
- range: SpreadsheetCellRange
  
  The range to intersect with.
Returns SpreadsheetCellRange

intersectsWith

intersectsWith(range: SpreadsheetCellRange): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:141
Returns a boolean indicating if the current and specified range overlap.

Returns
Returns true if the ranges have at least 1 row and column in common; otherwise false.

Parameters
- range: SpreadsheetCellRange
  
  The range to compare with.
Returns boolean

memberwiseClone

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

toString

toString(): string
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:48
Returns a string representation of the SpreadsheetCellRange

Returns
A string representation of the row and column indices.

Returns string
toString(mode: CellReferenceMode): string
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:54
Returns a string representation of the range using the specified mode.

Returns
A string containing the upper left cell if this is a single cell otherwise a string containing the upper left and lower right cells.

Parameters
- mode: CellReferenceMode
  
  An enumeration used to indicate how references are represented
Returns string

union

union(range: SpreadsheetCellRange): SpreadsheetCellRange
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:155
Returns a range that contains the contains the current and specified range.

Returns
A range that is large enough to contain the current and specified range.

Parameters
- range: SpreadsheetCellRange
  
  The range to combine with.
Returns SpreadsheetCellRange

`Static` compare

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

`Static` compareSimple

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

`Static` equalsSimple

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

`Static` equalsStatic

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

`Static` getArrayOfProperties

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

`Static` getArrayOfValues

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

`Static` getHashCodeStatic

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

`Static` referenceEquals

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

`Static` staticInit

staticInit(): void
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetCellRange.d.ts:20
Returns void

Class SpreadsheetCellRange

Hierarchy

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

firstRow: number

firstColumn: number

Returns SpreadsheetCellRange

Parameters

firstRow: number

firstColumn: number

lastRow: number

lastColumn: number

Returns SpreadsheetCellRange

Parameters

address: string

Returns SpreadsheetCellRange

Returns SpreadsheetCellRange

Parameters

Rest ..._rest: any[]

Returns SpreadsheetCellRange

Properties

$type

Static $t

Static empty

Static nextHashCode

Accessors

firstColumn

Returns number

firstRow

Returns number

isEmpty

Returns boolean

isSingleCell

Returns boolean

lastColumn

Returns number

lastRow

Returns number

Methods

contains

Returns

Parameters

cell: SpreadsheetCell

Returns boolean

Returns

Parameters

range: SpreadsheetCellRange

Returns boolean

Returns

Parameters

row: number

column: number

Returns boolean

equals

Returns

Parameters

other: SpreadsheetCellRange

Returns boolean

Returns

Parameters

obj: any

Returns boolean

equals1

Returns

Parameters

obj: any

Returns boolean

getHashCode

Returns

Returns number

intersect

Returns

Parameters

`Static` $t

`Static` empty

`Static` nextHashCode

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` referenceEquals

`Static` staticInit