React Data GridLinkedPhysicalIndexToValueMap

On this page

• Description
• Methods
  • clearValue
  • getEntries
  • getLength
  • getValues
  • setValueAtIndex
  • setValues

Description

Map for storing mappings from an physical index to a value. Those entries are linked and stored in a certain order.

It does not update stored values on remove/add row or column action. Otherwise, order of entries is updated after such changes.

Methods

clearValue

Source code

linkedPhysicalIndexToValueMap.clearValue(physicalIndex)

Clear value for particular index.

Param	Type	Description
physicalIndex	number	Physical index.

getEntries

Source code

linkedPhysicalIndexToValueMap.getEntries() ⇒ Array

Get every entry containing index and value, respecting order of indexes.

getLength

Source code

linkedPhysicalIndexToValueMap.getLength() ⇒ number

Get length of the index map.

getValues

Source code

linkedPhysicalIndexToValueMap.getValues() ⇒ Array

Get full list of ordered values for particular indexes.

setValueAtIndex

Source code

linkedPhysicalIndexToValueMap.setValueAtIndex(index, value, position) ⇒ boolean

Set value at index and add it to the linked list of entries. Entries are stored in a certain order.

Note: Value will be added at the end of the queue.

Param	Type	Description
index	number	The index.
value	*	The value to save.
position	number	Position to which entry will be added.

setValues

Source code

linkedPhysicalIndexToValueMap.setValues(values)

Set new values for particular indexes. Entries are linked and stored in a certain order.

Note: Please keep in mind that change hook triggered by the method may not update cache of a collection immediately.

Param	Type	Description
values	Array	List of set values.