SimpleRangeValue
A class that represents a range of data.
Constructors
Section titled “Constructors”constructor
Section titled “constructor”+ new SimpleRangeValue(_data?: InternalScalarValue[][], range?: AbsoluteCellRange, dependencyGraph?: DependencyGraph, _hasOnlyNumbers?: undefined | false | true): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:21
In most cases, it’s more convenient to create a SimpleRangeValue object
by calling one of the static factory methods.
Parameters:
| Name | Type |
|---|---|
_data? | InternalScalarValue[][] |
range? | AbsoluteCellRange |
dependencyGraph? | DependencyGraph |
_hasOnlyNumbers? | undefined | false | true |
Returns: SimpleRangeValue
Properties
Section titled “Properties”• range? : AbsoluteCellRange
Defined in src/SimpleRangeValue.ts:33
A property that represents the address of the range.
• size: ArraySize
Defined in src/SimpleRangeValue.ts:21
A property that represents the size of the range.
Accessors
Section titled “Accessors”• get data(): InternalScalarValue[][]
Defined in src/SimpleRangeValue.ts:45
Returns the range data as a 2D array.
Returns: InternalScalarValue[][]
Methods
Section titled “Methods”effectiveAddressesFromData
Section titled “effectiveAddressesFromData”▸ effectiveAddressesFromData(leftCorner: SimpleCellAddress): IterableIterator‹SimpleCellAddress›
Defined in src/SimpleRangeValue.ts:125
Generates the addresses of the cells contained in the range assuming the provided address is the left corner of the range.
Parameters:
| Name | Type |
|---|---|
leftCorner | SimpleCellAddress |
Returns: IterableIterator‹SimpleCellAddress›
entriesFromTopLeftCorner
Section titled “entriesFromTopLeftCorner”▸ entriesFromTopLeftCorner(leftCorner: SimpleCellAddress): IterableIterator‹[InternalScalarValue, SimpleCellAddress]›
Defined in src/SimpleRangeValue.ts:139
Generates values and addresses of the cells contained in the range assuming the provided address is the left corner of the range.
This method combines the functionalities of iterateValuesFromTopLeftCorner() and effectiveAddressesFromData().
Parameters:
| Name | Type |
|---|---|
leftCorner | SimpleCellAddress |
Returns: IterableIterator‹[InternalScalarValue, SimpleCellAddress]›
hasOnlyNumbers
Section titled “hasOnlyNumbers”▸ hasOnlyNumbers(): boolean
Defined in src/SimpleRangeValue.ts:165
Returns true if and only if the range contains only numeric values.
Returns: boolean
height
Section titled “height”▸ height(): number
Defined in src/SimpleRangeValue.ts:102
Returns the number of rows contained in the range.
Returns: number
isAdHoc
Section titled “isAdHoc”▸ isAdHoc(): boolean
Defined in src/SimpleRangeValue.ts:88
Returns true if and only if the SimpleRangeValue has no address set.
Returns: boolean
iterateValuesFromTopLeftCorner
Section titled “iterateValuesFromTopLeftCorner”▸ iterateValuesFromTopLeftCorner(): IterableIterator‹InternalScalarValue›
Defined in src/SimpleRangeValue.ts:151
Generates the values of the cells contained in the range assuming the provided address is the left corner of the range.
Returns: IterableIterator‹InternalScalarValue›
numberOfElements
Section titled “numberOfElements”▸ numberOfElements(): number
Defined in src/SimpleRangeValue.ts:158
Returns the number of cells contained in the range.
Returns: number
rawData
Section titled “rawData”▸ rawData(): InternalScalarValue[][]
Defined in src/SimpleRangeValue.ts:196
Returns the range data as a 2D array.
Internal use only.
Returns: InternalScalarValue[][]
rawNumbers
Section titled “rawNumbers”▸ rawNumbers(): number[][]
Defined in src/SimpleRangeValue.ts:186
Returns the range data as a 2D array of numbers.
Internal use only.
Returns: number[][]
sameDimensionsAs
Section titled “sameDimensionsAs”▸ sameDimensionsAs(other: SimpleRangeValue): boolean
Defined in src/SimpleRangeValue.ts:204
Returns true if and only if the range has the same width and height as the other range object.
Parameters:
| Name | Type |
|---|---|
other | SimpleRangeValue |
Returns: boolean
valuesFromTopLeftCorner
Section titled “valuesFromTopLeftCorner”▸ valuesFromTopLeftCorner(): InternalScalarValue[]
Defined in src/SimpleRangeValue.ts:109
Returns the range data as a 1D array.
Returns: InternalScalarValue[]
▸ width(): number
Defined in src/SimpleRangeValue.ts:95
Returns the number of columns contained in the range.
Returns: number
fromRange
Section titled “fromRange”▸ fromRange(data: InternalScalarValue[][], range: AbsoluteCellRange, dependencyGraph: DependencyGraph): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:53
A factory method. Returns a SimpleRangeValue object with the provided range address and the provided data.
Parameters:
| Name | Type |
|---|---|
data | InternalScalarValue[][] |
range | AbsoluteCellRange |
dependencyGraph | DependencyGraph |
Returns: SimpleRangeValue
fromScalar
Section titled “fromScalar”▸ fromScalar(scalar: InternalScalarValue): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:81
A factory method. Returns a SimpleRangeValue object that contains a single value.
Parameters:
| Name | Type |
|---|---|
scalar | InternalScalarValue |
Returns: SimpleRangeValue
onlyNumbers
Section titled “onlyNumbers”▸ onlyNumbers(data: number[][]): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:60
A factory method. Returns a SimpleRangeValue object with the provided numeric data.
Parameters:
| Name | Type |
|---|---|
data | number[][] |
Returns: SimpleRangeValue
onlyRange
Section titled “onlyRange”▸ onlyRange(range: AbsoluteCellRange, dependencyGraph: DependencyGraph): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:74
A factory method. Returns a SimpleRangeValue object with the provided range address.
Parameters:
| Name | Type |
|---|---|
range | AbsoluteCellRange |
dependencyGraph | DependencyGraph |
Returns: SimpleRangeValue
onlyValues
Section titled “onlyValues”▸ onlyValues(data: InternalScalarValue[][]): SimpleRangeValue
Defined in src/SimpleRangeValue.ts:67
A factory method. Returns a SimpleRangeValue object with the provided data.
Parameters:
| Name | Type |
|---|---|
data | InternalScalarValue[][] |
Returns: SimpleRangeValue