ISharedSegmentSequence Interface

Packages > fluid-framework > ISharedSegmentSequence

Signature

export interface ISharedSegmentSequence<T extends ISegment> extends ISharedObject<ISharedSegmentSequenceEvents>, ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver

Extends: ISharedObject <ISharedSegmentSequenceEvents >, ISharedIntervalCollection <SequenceInterval >, MergeTreeRevertibleDriver

Type Parameters

Methods

Method Details

annotateRange

Annotates the range with the provided properties

Signature

annotateRange(start: number, end: number, props: PropertySet): void;

Parameters

createLocalReferencePosition

Creates a LocalReferencePosition on this SharedString. If the refType does not include ReferenceType.Transient, the returned reference will be added to the localRefs on the provided segment.

Signature

createLocalReferencePosition(segment: T, offset: number, refType: ReferenceType, properties: PropertySet | undefined, slidingPreference?: SlidingPreference, canSlideToEndpoint?: boolean): LocalReferencePosition;

Parameters

Returns

Return type: LocalReferencePosition

getContainingSegment

Finds the segment information (i.e. segment + offset) corresponding to a character position in the SharedString. If the position is past the end of the string, segment and offset on the returned object may be undefined.

Signature

getContainingSegment(pos: number): {
        segment: T | undefined;
        offset: number | undefined;
    };

Parameters

Returns

Return type: { segment: T | undefined; offset: number | undefined; }

getCurrentSeq

Signature

getCurrentSeq(): number;

Returns

The most recent sequence number which has been acked by the server and processed by this SharedSegmentSequence.

Return type: number

getIntervalCollection

Retrieves the interval collection keyed on label. If no such interval collection exists, creates one.

Signature

getIntervalCollection(label: string): IIntervalCollection<SequenceInterval>;

Parameters

Returns

Return type: IIntervalCollection <SequenceInterval >

getIntervalCollectionLabels

Signature

getIntervalCollectionLabels(): IterableIterator<string>;

Example

const iter = this.getIntervalCollectionKeys();
for (key of iter)
    const collection = this.getIntervalCollection(key);
    ...

Returns

An iterable object that enumerates the IntervalCollection labels.

Return type: IterableIterator<string>

getLength

Returns the length of the current sequence for the client

Signature

getLength(): number;

Returns

Return type: number

getPosition

Returns the current position of a segment, and -1 if the segment does not exist in this sequence

Signature

getPosition(segment: ISegment): number;

Parameters

Returns

Return type: number

getPropertiesAtPosition

Signature

getPropertiesAtPosition(pos: number): PropertySet | undefined;

Parameters

Returns

Return type: PropertySet | undefined

getRangeExtentsOfPosition

Signature

getRangeExtentsOfPosition(pos: number): {
        posStart: number | undefined;
        posAfterEnd: number | undefined;
    };

Parameters

Returns

Return type: { posStart: number | undefined; posAfterEnd: number | undefined; }

groupOperation

Signature

groupOperation(groupOp: IMergeTreeGroupMsg): void;

Parameters

initializeLocal

Initializes the object as a local, non-shared object. This object can become shared after it is attached to the document.

Signature

initializeLocal(): void;

insertAtReferencePosition

Inserts a segment directly before a ReferencePosition.

Signature

insertAtReferencePosition(pos: ReferencePosition, segment: T): void;

Parameters

insertFromSpec

Inserts a segment

Signature

insertFromSpec(pos: number, spec: IJSONSegment): void;

Parameters

localReferencePositionToPosition

Resolves a ReferencePosition into a character position using this client’s perspective.

Reference positions that point to a character that has been removed will always return the position of the nearest non-removed character, regardless of ReferenceType. To handle this case specifically, one may wish to look at the segment returned by ReferencePosition.getSegment.

Signature

localReferencePositionToPosition(lref: ReferencePosition): number;

Parameters

Returns

Return type: number

obliterateRange

Obliterate is similar to remove, but differs in that segments concurrently inserted into an obliterated range will also be removed

Signature

obliterateRange(start: number, end: number): void;

Parameters

posFromRelativePos

Given a position specified relative to a marker id, lookup the marker and convert the position to a character position.

Signature

posFromRelativePos(relativePos: IRelativePosition): number;

Parameters

Returns

Return type: number

removeLocalReferencePosition

Removes a LocalReferencePosition from this SharedString.

Signature

removeLocalReferencePosition(lref: LocalReferencePosition): LocalReferencePosition | undefined;

Parameters

Returns

Return type: LocalReferencePosition | undefined

removeRange

Signature

removeRange(start: number, end: number): void;

Parameters

resolveRemoteClientPosition

Resolves a remote client’s position against the local sequence and returns the remote client’s position relative to the local sequence. The client ref seq must be above the minimum sequence number or the return value will be undefined. Generally this method is used in conjunction with signals which provide point in time values for the below parameters, and is useful for things like displaying user position. It should not be used with persisted values as persisted values will quickly become invalid as the remoteClientRefSeq moves below the minimum sequence number

Signature

resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number | undefined;

Parameters

Returns

Return type: number | undefined

walkSegments

Walk the underlying segments of the sequence. The walked segments may extend beyond the range if the segments cross the ranges start or end boundaries.

Set split range to true to ensure only segments within the range are walked.

Signature

walkSegments<TClientData>(handler: ISegmentAction<TClientData>, start?: number, end?: number, accum?: TClientData, splitRange?: boolean): void;

Type Parameters

Parameters