Skip to main content
Version: v1

IIntervalCollectionEvent Interface

Signature​

export interface IIntervalCollectionEvent<TInterval extends ISerializableInterval> extends IEvent

Extends: IEvent

Type Parameters​

ParameterConstraintDescription
TIntervalISerializableInterval

Call Signatures​

Call SignatureReturn TypeDescription
(event: "changeInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): anyanyThis event is invoked whenever the properties or endpoints of an interval may have changed. This can happen on: - endpoint modification (local or remote) - ack of an endpoint modification - property change (local or remote) - position change due to segment sliding (will always appear as a local change) The interval argument reflects the new values.
(event: "addInterval" | "deleteInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage) => void): anyany
(event: "propertyChanged", listener: (interval: TInterval, propertyArgs: PropertySet) => void): anyany

Call Signature Details​

(event: "changeInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): any​

This event is invoked whenever the properties or endpoints of an interval may have changed. This can happen on: - endpoint modification (local or remote) - ack of an endpoint modification - property change (local or remote) - position change due to segment sliding (will always appear as a local change) The interval argument reflects the new values.

Signature​

(event: "changeInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): any;

(event: "addInterval" | "deleteInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage) => void): any​

Signature​

(event: "addInterval" | "deleteInterval", listener: (interval: TInterval, local: boolean, op: ISequencedDocumentMessage) => void): any;

(event: "propertyChanged", listener: (interval: TInterval, propertyArgs: PropertySet) => void): any​

Signature​

(event: "propertyChanged", listener: (interval: TInterval, propertyArgs: PropertySet) => void): any;