Options
Menu

Class ArrayReorderEvent

Emitted when an element is reordered from a RealTimeArray.

The value that was moved can be found at toIndex.

Hierarchy

  • ArrayReorderEvent

Implements

Index

Properties

element

The RealTimeArray or HistoricalArray which was modified

fromIndex

fromIndex: number

The prior index of the moved element

local

local: boolean

name

name: string = ArrayReorderEvent.NAME

The name of the event that was fired. This is commonly used to filter when using the ConvergenceEventEmitter.events stream.

Note that the name is only guaranteed to be unique within the class / subsystem that is firing it. Names might be reused across classes and subsystems.

sessionId

sessionId: string

The sessionId corresponding to the session that performed the modification

toIndex

toIndex: number

The new index of the element, whose value can be accessed by element.get(toIndex)

user

The user which performed the modification

StaticNAME

NAME: "reorder" = "reorder"