AbsoluteRowRange
Constructors
Section titled “Constructors”constructor
Section titled “constructor”+ new AbsoluteRowRange(sheet: number, rowStart: number, rowEnd: number): AbsoluteRowRange
Defined in src/AbsoluteCellRange.ts:495
Parameters:
| Name | Type |
|---|---|
sheet | number |
rowStart | number |
rowEnd | number |
Returns: AbsoluteRowRange
Properties
Section titled “Properties”• end: SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:47
• start: SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:46
Accessors
Section titled “Accessors”• get sheet(): number
Defined in src/AbsoluteCellRange.ts:60
Returns: number
Methods
Section titled “Methods”addressInRange
Section titled “addressInRange”▸ addressInRange(address: SimpleCellAddress): boolean
Defined in src/AbsoluteCellRange.ts:157
Parameters:
| Name | Type |
|---|---|
address | SimpleCellAddress |
Returns: boolean
addresses
Section titled “addresses”▸ addresses(dependencyGraph: DependencyGraph): SimpleCellAddress[]
Defined in src/AbsoluteCellRange.ts:315
Parameters:
| Name | Type |
|---|---|
dependencyGraph | DependencyGraph |
Returns: SimpleCellAddress[]
addressesArrayMap
Section titled “addressesArrayMap”▸ addressesArrayMap‹T›(dependencyGraph: DependencyGraph, op: function): T[][]
Defined in src/AbsoluteCellRange.ts:299
Type parameters:
▪ T
Parameters:
▪ dependencyGraph: DependencyGraph
▪ op: function
▸ (arg: SimpleCellAddress): T
Parameters:
| Name | Type |
|---|---|
arg | SimpleCellAddress |
Returns: T[][]
addressesWithDirection
Section titled “addressesWithDirection”▸ addressesWithDirection(right: number, bottom: number, dependencyGraph: DependencyGraph): IterableIterator‹SimpleCellAddress›
Defined in src/AbsoluteCellRange.ts:331
Parameters:
| Name | Type |
|---|---|
right | number |
bottom | number |
dependencyGraph | DependencyGraph |
Returns: IterableIterator‹SimpleCellAddress›
arrayOfAddressesInRange
Section titled “arrayOfAddressesInRange”▸ arrayOfAddressesInRange(): SimpleCellAddress[][]
Defined in src/AbsoluteCellRange.ts:275
Returns: SimpleCellAddress[][]
columnInRange
Section titled “columnInRange”▸ columnInRange(address: SimpleColumnAddress): boolean
Defined in src/AbsoluteCellRange.ts:168
Parameters:
| Name | Type |
|---|---|
address | SimpleColumnAddress |
Returns: boolean
containsRange
Section titled “containsRange”▸ containsRange(range: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:182
Parameters:
| Name | Type |
|---|---|
range | AbsoluteCellRange |
Returns: boolean
doesOverlap
Section titled “doesOverlap”▸ doesOverlap(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:144
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
effectiveEndColumn
Section titled “effectiveEndColumn”▸ effectiveEndColumn(dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:536
Parameters:
| Name | Type |
|---|---|
dependencyGraph | DependencyGraph |
Returns: number
effectiveEndRow
Section titled “effectiveEndRow”▸ effectiveEndRow(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:394
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
effectiveHeight
Section titled “effectiveHeight”▸ effectiveHeight(_dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:402
Parameters:
| Name | Type |
|---|---|
_dependencyGraph | DependencyGraph |
Returns: number
effectiveWidth
Section titled “effectiveWidth”▸ effectiveWidth(dependencyGraph: DependencyGraph): number
Defined in src/AbsoluteCellRange.ts:540
Parameters:
| Name | Type |
|---|---|
dependencyGraph | DependencyGraph |
Returns: number
exceedsSheetSizeLimits
Section titled “exceedsSheetSizeLimits”▸ exceedsSheetSizeLimits(_maxColumns: number, maxRows: number): boolean
Defined in src/AbsoluteCellRange.ts:532
Parameters:
| Name | Type |
|---|---|
_maxColumns | number |
maxRows | number |
Returns: boolean
expandByColumns
Section titled “expandByColumns”▸ expandByColumns(_numberOfColumns: number): void
Defined in src/AbsoluteCellRange.ts:520
Parameters:
| Name | Type |
|---|---|
_numberOfColumns | number |
Returns: void
expandByRows
Section titled “expandByRows”▸ expandByRows(numberOfRows: number): void
Defined in src/AbsoluteCellRange.ts:217
Parameters:
| Name | Type |
|---|---|
numberOfRows | number |
Returns: void
getAddress
Section titled “getAddress”▸ getAddress(col: number, row: number): SimpleCellAddress
Defined in src/AbsoluteCellRange.ts:379
Parameters:
| Name | Type |
|---|---|
col | number |
row | number |
Returns: SimpleCellAddress
height
Section titled “height”▸ height(): number
Defined in src/AbsoluteCellRange.ts:267
Returns: number
includesColumn
Section titled “includesColumn”▸ includesColumn(column: number): boolean
Defined in src/AbsoluteCellRange.ts:208
Parameters:
| Name | Type |
|---|---|
column | number |
Returns: boolean
includesRow
Section titled “includesRow”▸ includesRow(row: number): boolean
Defined in src/AbsoluteCellRange.ts:204
Parameters:
| Name | Type |
|---|---|
row | number |
Returns: boolean
intersectionWith
Section titled “intersectionWith”▸ intersectionWith(other: AbsoluteCellRange): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:186
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: Maybe‹AbsoluteCellRange›
isFinite
Section titled “isFinite”▸ isFinite(): boolean
Defined in src/AbsoluteCellRange.ts:140
Returns: boolean
moveToSheet
Section titled “moveToSheet”▸ moveToSheet(toSheet: number): void
Defined in src/AbsoluteCellRange.ts:234
Parameters:
| Name | Type |
|---|---|
toSheet | number |
Returns: void
rangeWithSameHeight
Section titled “rangeWithSameHeight”▸ rangeWithSameHeight(startColumn: number, numberOfColumns: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:255
Parameters:
| Name | Type |
|---|---|
startColumn | number |
numberOfColumns | number |
Returns: AbsoluteCellRange
rangeWithSameWidth
Section titled “rangeWithSameWidth”▸ rangeWithSameWidth(startRow: number, numberOfRows: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:528
Parameters:
| Name | Type |
|---|---|
startRow | number |
numberOfRows | number |
Returns: AbsoluteCellRange
removeSpan
Section titled “removeSpan”▸ removeSpan(span: Span): void
Defined in src/AbsoluteCellRange.ts:239
Parameters:
| Name | Type |
|---|---|
span | Span |
Returns: void
rowInRange
Section titled “rowInRange”▸ rowInRange(address: SimpleRowAddress): boolean
Defined in src/AbsoluteCellRange.ts:175
Parameters:
| Name | Type |
|---|---|
address | SimpleRowAddress |
Returns: boolean
sameAs
Section titled “sameAs”▸ sameAs(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:295
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
sameDimensionsAs
Section titled “sameDimensionsAs”▸ sameDimensionsAs(other: AbsoluteCellRange): boolean
Defined in src/AbsoluteCellRange.ts:291
Parameters:
| Name | Type |
|---|---|
other | AbsoluteCellRange |
Returns: boolean
shiftByColumns
Section titled “shiftByColumns”▸ shiftByColumns(_numberOfColumns: number): void
Defined in src/AbsoluteCellRange.ts:516
Parameters:
| Name | Type |
|---|---|
_numberOfColumns | number |
Returns: void
shiftByRows
Section titled “shiftByRows”▸ shiftByRows(numberOfRows: number): void
Defined in src/AbsoluteCellRange.ts:212
Parameters:
| Name | Type |
|---|---|
numberOfRows | number |
Returns: void
shifted
Section titled “shifted”▸ shifted(byCols: number, byRows: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:524
Parameters:
| Name | Type |
|---|---|
byCols | number |
byRows | number |
Returns: AbsoluteCellRange
shouldBeRemoved
Section titled “shouldBeRemoved”▸ shouldBeRemoved(): boolean
Defined in src/AbsoluteCellRange.ts:512
Returns: boolean
▸ size(): number
Defined in src/AbsoluteCellRange.ts:271
Returns: number
toString
Section titled “toString”▸ toString(): string
Defined in src/AbsoluteCellRange.ts:259
Returns: string
▸ width(): number
Defined in src/AbsoluteCellRange.ts:263
Returns: number
withStart
Section titled “withStart”▸ withStart(newStart: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:287
Parameters:
| Name | Type |
|---|---|
newStart | SimpleCellAddress |
Returns: AbsoluteCellRange
fromAst
Section titled “fromAst”▸ fromAst(ast: CellRangeAst | ColumnRangeAst | RowRangeAst, baseAddress: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:83
Parameters:
| Name | Type |
|---|---|
ast | CellRangeAst | ColumnRangeAst | RowRangeAst |
baseAddress | SimpleCellAddress |
Returns: AbsoluteCellRange
fromAstOrUndef
Section titled “fromAstOrUndef”▸ fromAstOrUndef(ast: CellRangeAst | ColumnRangeAst | RowRangeAst, baseAddress: SimpleCellAddress): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:93
Parameters:
| Name | Type |
|---|---|
ast | CellRangeAst | ColumnRangeAst | RowRangeAst |
baseAddress | SimpleCellAddress |
Returns: Maybe‹AbsoluteCellRange›
fromCellRange
Section titled “fromCellRange”▸ fromCellRange(x: CellRange, baseAddress: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:101
Parameters:
| Name | Type |
|---|---|
x | CellRange |
baseAddress | SimpleCellAddress |
Returns: AbsoluteCellRange
fromCoordinates
Section titled “fromCoordinates”▸ fromCoordinates(sheet: number, x1: number, y1: number, x2: number, y2: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:136
Parameters:
| Name | Type |
|---|---|
sheet | number |
x1 | number |
y1 | number |
x2 | number |
y2 | number |
Returns: AbsoluteCellRange
fromRowRangeAst
Section titled “fromRowRangeAst”▸ fromRowRangeAst(x: RowRangeAst, baseAddress: SimpleCellAddress): AbsoluteRowRange
Defined in src/AbsoluteCellRange.ts:503
Parameters:
| Name | Type |
|---|---|
x | RowRangeAst |
baseAddress | SimpleCellAddress |
Returns: AbsoluteRowRange
fromSimpleCellAddresses
Section titled “fromSimpleCellAddresses”▸ fromSimpleCellAddresses(start: SimpleCellAddress, end: SimpleCellAddress): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:64
Parameters:
| Name | Type |
|---|---|
start | SimpleCellAddress |
end | SimpleCellAddress |
Returns: AbsoluteCellRange
spanFrom
Section titled “spanFrom”▸ spanFrom(topLeftCorner: SimpleCellAddress, width: number, height: number): AbsoluteCellRange
Defined in src/AbsoluteCellRange.ts:108
Parameters:
| Name | Type |
|---|---|
topLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: AbsoluteCellRange
spanFromOrUndef
Section titled “spanFromOrUndef”▸ spanFromOrUndef(topLeftCorner: SimpleCellAddress, width: number, height: number): Maybe‹AbsoluteCellRange›
Defined in src/AbsoluteCellRange.ts:116
Parameters:
| Name | Type |
|---|---|
topLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: Maybe‹AbsoluteCellRange›