Skip to main content
Version: v1

ISharedSegmentSequenceEvents Interface

Events emitted in response to changes to the sequence data.

Signature

export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents

Extends: ISharedObjectEvents

Remarks

The following is the list of events emitted.

### "sequenceDelta"

The sequenceDelta event is emitted when segments are inserted, annotated, or removed.

#### Listener signature

(event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void
  • event - Various information on the segments that were modified.

  • target - The sequence itself.

### "maintenance"

The maintenance event is emitted when segments are modified during merge-tree maintenance.

#### Listener signature

(event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void
  • event - Various information on the segments that were modified.

  • target - The sequence itself.

Call Signatures

CallSignature Description
(event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): any
(event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): any
(event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): any

Call Signature Details

(event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): any

Signature

(event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): any;

(event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): any

Signature

(event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): any;

(event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): any

Signature

(event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): any;