This page covers a non-latest version of Handsontable.

# IndexMapper

Description
Methods

# Description

Index mapper stores, registers and manages the indexes on the basis of calculations collected from the subsidiary maps. It should be seen as a single source of truth (regarding row and column indexes, for example, their sequence, information if they are skipped in the process of rendering (hidden or trimmed), values linked to them) for any operation that considers CRUD actions such as insertion, movement, removal etc, and is used to properly calculate physical and visual indexes translations in both ways. It has a built-in cache that is updated only when the data or structure changes.

Physical index is a type of an index from the sequence of indexes assigned to the data source rows or columns (from 0 to n, where n is number of the cells on the axis of data set). Visual index is a type of an index from the sequence of indexes assigned to rows or columns existing in DataMap (from 0 to n, where n is number of the cells on the axis of data set). Renderable index is a type of an index from the sequence of indexes assigned to rows or columns whose may be rendered (when they are in a viewport; from 0 to n, where n is number of the cells renderable on the axis).

There are different kinds of index maps which may be registered in the collections and can be used by a reference. They also expose public API and trigger two local hooks such as init (on initialization) and change (on change).

These are: IndexesSequence, PhysicalIndexToValueMap, LinkedPhysicalIndexToValueMap, HidingMap, and TrimmingMap.

Param	Type	Description
indexName	`string`	The uniq index name.
mapType	`string`	The index map type (e.q. "hiding, "trimming", "physicalIndexToValue").
[initValueOrFn]	`*`	`optional` The initial value for the index map.

Param	Type	Default	Description
fromVisualIndex	`number`		Visual start index. Starting point for finding destination index. Start point may be destination point when handled index is NOT hidden.
incrementBy	`number`		We are searching for a next visible indexes by increasing (to be precise, or decreasing) indexes. This variable represent indexes shift. We are looking for an index: - for rows: from the left to the right (increasing indexes, then variable should have value 1) or other way around (decreasing indexes, then variable should have the value -1) - for columns: from the top to the bottom (increasing indexes, then variable should have value 1) or other way around (decreasing indexes, then variable should have the value -1).
searchAlsoOtherWayAround	`boolean`	`false`	The argument determine if an additional other way around search should be performed, when the search in the first direction had no effect in finding visual index.
indexForNextSearch	`number`		Visual index for next search, when the flag is truthy.

Param	Type	Description
movedIndexes	`number` `Array`	Visual index(es) to move.
finalIndex	`number`	Visual index being a start index for the moved elements.

Param	Type	Description
uniqueName	`string`	Name of the index map. It should be unique.
indexMap	`IndexMap`	Registered index map updated on items removal and insertion.

# IndexMapper

# Description

# Methods

# createAndRegisterIndexMap

# createChangesObserver

# fitToLength

# getFirstNotHiddenIndex

# getIndexesSequence

# getNotHiddenIndexes

# getNotHiddenIndexesLength

# getNotTrimmedIndexes

# getNotTrimmedIndexesLength

# getNumberOfIndexes

# getPhysicalFromRenderableIndex

# getPhysicalFromVisualIndex

# getRenderableFromVisualIndex

# getRenderableIndexes

# getRenderableIndexesLength

# getVisualFromPhysicalIndex

# getVisualFromRenderableIndex

# initToLength

# isHidden

# isTrimmed

# moveIndexes

# registerMap

# resumeOperations

# setIndexesSequence

# suspendOperations

# unregisterAll

# unregisterMap