# ColumnIndex Class
# Constructors
# constructor
+ new ColumnIndex(dependencyGraph: DependencyGraph, config: Config, stats: Statistics): ColumnIndex
Defined in src/Lookup/ColumnIndex.ts:43 (opens new window)
Parameters:
| Name | Type |
|---|---|
dependencyGraph | DependencyGraph |
config | Config |
stats | Statistics |
Returns: ColumnIndex
# Methods
# add
▸ add(value: RawInterpreterValue, address: SimpleCellAddress): void
Defined in src/Lookup/ColumnIndex.ts:54 (opens new window)
Parameters:
| Name | Type |
|---|---|
value | RawInterpreterValue |
address | SimpleCellAddress |
Returns: void
# addColumns
▸ addColumns(columnsSpan: ColumnsSpan): void
Defined in src/Lookup/ColumnIndex.ts:165 (opens new window)
Parameters:
| Name | Type |
|---|---|
columnsSpan | ColumnsSpan |
Returns: void
# advancedFind
▸ advancedFind(keyMatcher: function, range: SimpleRangeValue, options: AdvancedFindOptions): number
Defined in src/Lookup/ColumnIndex.ts:161 (opens new window)
Parameters:
▪ keyMatcher: function
▸ (arg: RawInterpreterValue): boolean
Parameters:
| Name | Type |
|---|---|
arg | RawInterpreterValue |
▪ range: SimpleRangeValue
▪Default value options: AdvancedFindOptions= { returnOccurrence: 'first' }
Returns: number
# applyChanges
▸ applyChanges(contentChanges: CellValueChange[]): void
Defined in src/Lookup/ColumnIndex.ts:88 (opens new window)
Parameters:
| Name | Type |
|---|---|
contentChanges | CellValueChange[] |
Returns: void
# change
▸ change(oldValue: RawInterpreterValue | undefined, newValue: RawInterpreterValue, address: SimpleCellAddress): void
Defined in src/Lookup/ColumnIndex.ts:80 (opens new window)
Parameters:
| Name | Type |
|---|---|
oldValue | RawInterpreterValue | undefined |
newValue | RawInterpreterValue |
address | SimpleCellAddress |
Returns: void
# ensureRecentData
▸ ensureRecentData(sheet: number, col: number, value: RawInterpreterValue): void
Defined in src/Lookup/ColumnIndex.ts:233 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
col | number |
value | RawInterpreterValue |
Returns: void
# find
▸ find(searchKey: RawNoErrorScalarValue, rangeValue: SimpleRangeValue, __namedParameters: object): number
Defined in src/Lookup/ColumnIndex.ts:110 (opens new window)
Parameters:
▪ searchKey: RawNoErrorScalarValue
▪ rangeValue: SimpleRangeValue
▪ __namedParameters: object
| Name | Type |
|---|---|
ifNoMatch | "returnLowerBound" | "returnUpperBound" | "returnNotFound" |
ordering | "none" | "asc" | "desc" |
returnOccurrence | undefined | "first" | "last" |
Returns: number
# forceApplyPostponedTransformations
▸ forceApplyPostponedTransformations(): void
Defined in src/Lookup/ColumnIndex.ts:192 (opens new window)
Forces all ValueIndex entries to apply any pending lazy transformations, bringing every entry up to the current LazilyTransformingAstService version. Must be called before compacting LazilyTransformingAstService.
Returns: void
# getColumnMap
▸ getColumnMap(sheet: number, col: number): ColumnMap
Defined in src/Lookup/ColumnIndex.ts:205 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
col | number |
Returns: ColumnMap
# getValueIndex
▸ getValueIndex(sheet: number, col: number, value: RawInterpreterValue): ValueIndex
Defined in src/Lookup/ColumnIndex.ts:220 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
col | number |
value | RawInterpreterValue |
Returns: ValueIndex
# moveValues
▸ moveValues(sourceRange: IterableIterator‹[RawScalarValue, SimpleCellAddress]›, toRight: number, toBottom: number, toSheet: number): void
Defined in src/Lookup/ColumnIndex.ts:96 (opens new window)
Parameters:
| Name | Type |
|---|---|
sourceRange | IterableIterator‹[RawScalarValue, SimpleCellAddress]› |
toRight | number |
toBottom | number |
toSheet | number |
Returns: void
# remove
▸ remove(value: RawInterpreterValue | undefined, address: SimpleCellAddress): void
Defined in src/Lookup/ColumnIndex.ts:66 (opens new window)
Parameters:
| Name | Type |
|---|---|
value | RawInterpreterValue | undefined |
address | SimpleCellAddress |
Returns: void
# removeColumns
▸ removeColumns(columnsSpan: ColumnsSpan): void
Defined in src/Lookup/ColumnIndex.ts:174 (opens new window)
Parameters:
| Name | Type |
|---|---|
columnsSpan | ColumnsSpan |
Returns: void
# removeSheet
▸ removeSheet(sheetId: number): void
Defined in src/Lookup/ColumnIndex.ts:183 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
Returns: void
# removeValues
▸ removeValues(range: IterableIterator‹[RawScalarValue, SimpleCellAddress]›): void
Defined in src/Lookup/ColumnIndex.ts:104 (opens new window)
Parameters:
| Name | Type |
|---|---|
range | IterableIterator‹[RawScalarValue, SimpleCellAddress]› |
Returns: void