# AbsoluteCellRange Class
# Constructors
# constructor
+ new AbsoluteCellRange(start: SimpleCellAddress, end: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:41 (opens new window)
Parameters:
| Name | Type |
|---|---|
start | SimpleCellAddress |
end | SimpleCellAddress |
Returns: AbsoluteCellRange
# Properties
# end Readonly
• end: SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:41 (opens new window)
# start Readonly
• start: SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:40 (opens new window)
# Accessors
# sheet
• get sheet(): number
Defined in src/AbsoluteCellRange.ts:54 (opens new window)
Returns: number
# Methods
# addressInRange
▸ addressInRange(address: SimpleCellAddress): boolean
Defined in src/AbsoluteCellRange.ts:151 (opens new window)
Parameters:
| Name | Type |
|---|---|
address | SimpleCellAddress |
Returns: boolean
# addresses
▸ addresses(dependencyGraph: DependencyGraph): SimpleCellAddress[]
Defined in src/AbsoluteCellRange.ts:309 (opens new window)
Parameters:
| Name | Type |
|---|---|
dependencyGraph | DependencyGraph |
Returns: SimpleCellAddress[]
# addressesArrayMap
▸ addressesArrayMap‹T›(dependencyGraph: DependencyGraph, op: function): T[][]
Defined in src/AbsoluteCellRange.ts:293 (opens new window)
Type parameters:
▪ T
Parameters:
▪ dependencyGraph: DependencyGraph
▪ op: function
▸ (arg: SimpleCellAddress): T
Parameters:
| Name | Type |
|---|---|
arg | SimpleCellAddress |
Returns: T[][]
# addressesWithDirection
▸ addressesWithDirection(right: number, bottom: number, dependencyGraph: DependencyGraph): IterableIterator‹SimpleCellAddress›
Defined in src/AbsoluteCellRange.ts:325 (opens new window)
Parameters:
| Name | Type |
|---|---|
right | number |
bottom | number |
dependencyGraph | DependencyGraph |
Returns: IterableIterator‹SimpleCellAddress›
# arrayOfAddressesInRange
▸ arrayOfAddressesInRange(): SimpleCellAddress[][]
Defined in src/AbsoluteCellRange.ts:269 (opens new window)
Returns: SimpleCellAddress[][]
# columnInRange
▸ columnInRange(address: SimpleColumnAddress): boolean
Defined in src/AbsoluteCellRange.ts:162 (opens new window)
Parameters:
| Name | Type |
|---|---|
address | SimpleColumnAddress |
Returns: boolean
# containsRange
▸ containsRange(range: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:176 (opens new window)
Parameters:
| Name | Type |
|---|---|
range | AbsoluteCellRange |
Returns: boolean
# doesOverlap
▸ doesOverlap(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:138 (opens new window)
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
# effectiveEndColumn
▸ effectiveEndColumn(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:384 (opens new window)
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
# effectiveEndRow
▸ effectiveEndRow(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:388 (opens new window)
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
# effectiveHeight
▸ effectiveHeight(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:396 (opens new window)
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
# effectiveWidth
▸ effectiveWidth(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:392 (opens new window)
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
# exceedsSheetSizeLimits
▸ exceedsSheetSizeLimits(maxColumns: number, maxRows: number): boolean
Defined in src/AbsoluteCellRange.ts:380 (opens new window)
Parameters:
| Name | Type |
|---|---|
maxColumns | number |
maxRows | number |
Returns: boolean
# expandByColumns
▸ expandByColumns(numberOfColumns: number): void
Defined in src/AbsoluteCellRange.ts:224 (opens new window)
Parameters:
| Name | Type |
|---|---|
numberOfColumns | number |
Returns: void
# expandByRows
▸ expandByRows(numberOfRows: number): void
Defined in src/AbsoluteCellRange.ts:211 (opens new window)
Parameters:
| Name | Type |
|---|---|
numberOfRows | number |
Returns: void
# getAddress
▸ getAddress(col: number, row: number): SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:373 (opens new window)
Parameters:
| Name | Type |
|---|---|
col | number |
row | number |
Returns: SimpleCellAddress
# height
▸ height(): number
Defined in src/AbsoluteCellRange.ts:261 (opens new window)
Returns: number
# includesColumn
▸ includesColumn(column: number): boolean
Defined in src/AbsoluteCellRange.ts:202 (opens new window)
Parameters:
| Name | Type |
|---|---|
column | number |
Returns: boolean
# includesRow
▸ includesRow(row: number): boolean
Defined in src/AbsoluteCellRange.ts:198 (opens new window)
Parameters:
| Name | Type |
|---|---|
row | number |
Returns: boolean
# intersectionWith
▸ intersectionWith(other: AbsoluteCellRange): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:180 (opens new window)
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: Maybe‹AbsoluteCellRange›
# isFinite
▸ isFinite(): boolean
Defined in src/AbsoluteCellRange.ts:134 (opens new window)
Returns: boolean
# moveToSheet
▸ moveToSheet(toSheet: number): void
Defined in src/AbsoluteCellRange.ts:228 (opens new window)
Parameters:
| Name | Type |
|---|---|
toSheet | number |
Returns: void
# rangeWithSameHeight
▸ rangeWithSameHeight(startColumn: number, numberOfColumns: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:249 (opens new window)
Parameters:
| Name | Type |
|---|---|
startColumn | number |
numberOfColumns | number |
Returns: AbsoluteCellRange
# rangeWithSameWidth
▸ rangeWithSameWidth(startRow: number, numberOfRows: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:245 (opens new window)
Parameters:
| Name | Type |
|---|---|
startRow | number |
numberOfRows | number |
Returns: AbsoluteCellRange
# removeSpan
▸ removeSpan(span: Span): void
Defined in src/AbsoluteCellRange.ts:233 (opens new window)
Parameters:
| Name | Type |
|---|---|
span | Span |
Returns: void
# rowInRange
▸ rowInRange(address: SimpleRowAddress): boolean
Defined in src/AbsoluteCellRange.ts:169 (opens new window)
Parameters:
| Name | Type |
|---|---|
address | SimpleRowAddress |
Returns: boolean
# sameAs
▸ sameAs(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:289 (opens new window)
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
# sameDimensionsAs
▸ sameDimensionsAs(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:285 (opens new window)
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
# shiftByColumns
▸ shiftByColumns(numberOfColumns: number): void
Defined in src/AbsoluteCellRange.ts:215 (opens new window)
Parameters:
| Name | Type |
|---|---|
numberOfColumns | number |
Returns: void
# shiftByRows
▸ shiftByRows(numberOfRows: number): void
Defined in src/AbsoluteCellRange.ts:206 (opens new window)
Parameters:
| Name | Type |
|---|---|
numberOfRows | number |
Returns: void
# shifted
▸ shifted(byCols: number, byRows: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:220 (opens new window)
Parameters:
| Name | Type |
|---|---|
byCols | number |
byRows | number |
Returns: AbsoluteCellRange
# shouldBeRemoved
▸ shouldBeRemoved(): boolean
Defined in src/AbsoluteCellRange.ts:241 (opens new window)
Returns: boolean
# size
▸ size(): number
Defined in src/AbsoluteCellRange.ts:265 (opens new window)
Returns: number
# toString
▸ toString(): string
Defined in src/AbsoluteCellRange.ts:253 (opens new window)
Returns: string
# width
▸ width(): number
Defined in src/AbsoluteCellRange.ts:257 (opens new window)
Returns: number
# withStart
▸ withStart(newStart: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:281 (opens new window)
Parameters:
| Name | Type |
|---|---|
newStart | SimpleCellAddress |
Returns: AbsoluteCellRange
# fromAst Static
▸ fromAst(ast: CellRangeAst | ColumnRangeAst | RowRangeAst, baseAddress: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:77 (opens new window)
Parameters:
| Name | Type |
|---|---|
ast | CellRangeAst | ColumnRangeAst | RowRangeAst |
baseAddress | SimpleCellAddress |
Returns: AbsoluteCellRange
# fromAstOrUndef Static
▸ fromAstOrUndef(ast: CellRangeAst | ColumnRangeAst | RowRangeAst, baseAddress: SimpleCellAddress): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:87 (opens new window)
Parameters:
| Name | Type |
|---|---|
ast | CellRangeAst | ColumnRangeAst | RowRangeAst |
baseAddress | SimpleCellAddress |
Returns: Maybe‹AbsoluteCellRange›
# fromCellRange Static
▸ fromCellRange(x: CellRange, baseAddress: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:95 (opens new window)
Parameters:
| Name | Type |
|---|---|
x | CellRange |
baseAddress | SimpleCellAddress |
Returns: AbsoluteCellRange
# fromCoordinates Static
▸ fromCoordinates(sheet: number, x1: number, y1: number, x2: number, y2: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:130 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
x1 | number |
y1 | number |
x2 | number |
y2 | number |
Returns: AbsoluteCellRange
# fromSimpleCellAddresses Static
▸ fromSimpleCellAddresses(start: SimpleCellAddress, end: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:58 (opens new window)
Parameters:
| Name | Type |
|---|---|
start | SimpleCellAddress |
end | SimpleCellAddress |
Returns: AbsoluteCellRange
# spanFrom Static
▸ spanFrom(topLeftCorner: SimpleCellAddress, width: number, height: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:102 (opens new window)
Parameters:
| Name | Type |
|---|---|
topLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: AbsoluteCellRange
# spanFromOrUndef Static
▸ spanFromOrUndef(topLeftCorner: SimpleCellAddress, width: number, height: number): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:110 (opens new window)
Parameters:
| Name | Type |
|---|---|
topLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: Maybe‹AbsoluteCellRange›