Packages > @fluidframework/merge-tree

@fluidframework/merge-tree Package

Interfaces

Interface Alerts Modifiers Description
IAttributionCollection ALPHA
IAttributionCollectionSpec ALPHA
IClientEvents ALPHA Emitted before this client's merge-tree normalizes its segments on reconnect, potentially ordering them. Useful for DDS-like consumers built atop the merge-tree to compute any information they need for rebasing their ops on reconnection.
ICombiningOp ALPHA, DEPRECATED
IJSONMarkerSegment ALPHA
IJSONSegment ALPHA
IMarkerDef ALPHA
IMergeNodeCommon ALPHA Common properties for a node in a merge tree.
IMergeTreeAnnotateMsg ALPHA
IMergeTreeDelta ALPHA
IMergeTreeDeltaCallbackArgs ALPHA
IMergeTreeDeltaOpArgs ALPHA
IMergeTreeGroupMsg ALPHA, DEPRECATED
IMergeTreeInsertMsg ALPHA
IMergeTreeMaintenanceCallbackArgs ALPHA
IMergeTreeRemoveMsg ALPHA
IMergeTreeSegmentDelta ALPHA
IMergeTreeTextHelper ALPHA, DEPRECATED
IRelativePosition ALPHA A position specified relative to a segment.
IRemovalInfo ALPHA Contains removal information associated to an ISegment.
ISegment ALPHA A segment representing a portion of the merge tree. Segments are leaf nodes of the merge tree and contain data.
ISegmentAction ALPHA
ITrackingGroup ALPHA
LocalReferencePosition ALPHA sealed
MapLike ALPHA
MergeTreeRevertibleDriver ALPHA
ReferencePosition ALPHA Represents a reference to a place within a merge tree. This place conceptually remains stable over time by referring to a particular segment and offset within that segment. Thus, this reference's character position changes as the tree is edited.
SegmentGroup ALPHA, DEPRECATED

Classes

Class Alerts Description
BaseSegment ALPHA
Client ALPHA, DEPRECATED
CollaborationWindow ALPHA, DEPRECATED
LocalReferenceCollection ALPHA Represents a collection of LocalReferencePositions associated with one segment in a merge-tree.
Marker ALPHA
MergeNode ALPHA
PropertiesManager ALPHA
SegmentGroupCollection ALPHA
Stack ALPHA, DEPRECATED
TextSegment ALPHA
TrackingGroup ALPHA
TrackingGroupCollection ALPHA

Enumerations

Enum Alerts Description
PropertiesRollback ALPHA
ReferenceType ALPHA Flags enum that dictates behavior of a ReferencePosition

Types

TypeAlias Alerts Description
IMergeTreeDeltaOp ALPHA
IMergeTreeOp ALPHA
MergeTreeDeltaOperationType ALPHA
MergeTreeDeltaOperationTypes ALPHA
MergeTreeDeltaType ALPHA
MergeTreeMaintenanceType ALPHA
PropertySet ALPHA
RangeStackMap ALPHA, DEPRECATED
SlidingPreference ALPHA Dictates the preferential direction for a ReferencePosition to slide in a merge-tree
Trackable ALPHA

Variables

Variable Alerts Modifiers Description
MergeTreeDeltaType ALPHA readonly
MergeTreeMaintenanceType ALPHA readonly

Enum-like constant defining the types of "maintenance" events on a merge tree. Maintenance events correspond to structural segment changes or acks of pending segments.

Note: these values are assigned negative integers to avoid clashing with MergeTreeDeltaType.

SlidingPreference ALPHA readonly Dictates the preferential direction for a ReferencePosition to slide in a merge-tree

Type Details

IMergeTreeDeltaOp (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type IMergeTreeDeltaOp = IMergeTreeInsertMsg | IMergeTreeRemoveMsg | IMergeTreeAnnotateMsg;

IMergeTreeOp (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type IMergeTreeOp = IMergeTreeDeltaOp | IMergeTreeGroupMsg;

MergeTreeDeltaOperationType (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type MergeTreeDeltaOperationType = typeof MergeTreeDeltaType.ANNOTATE | typeof MergeTreeDeltaType.INSERT | typeof MergeTreeDeltaType.REMOVE;

MergeTreeDeltaOperationTypes (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationType | MergeTreeMaintenanceType;

MergeTreeDeltaType (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type MergeTreeDeltaType = (typeof MergeTreeDeltaType)[keyof typeof MergeTreeDeltaType];

MergeTreeMaintenanceType (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type MergeTreeMaintenanceType = (typeof MergeTreeMaintenanceType)[keyof typeof MergeTreeMaintenanceType];

PropertySet (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type PropertySet = MapLike<any>;

RangeStackMap (ALPHA)

API This

This functionality is deprecated and will be removed in a future release.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type RangeStackMap = MapLike<Stack<ReferencePosition>>;

SlidingPreference (ALPHA)

Dictates the preferential direction for a ReferencePosition to slide in a merge-tree

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type SlidingPreference = (typeof SlidingPreference)[keyof typeof SlidingPreference];

Trackable (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type Trackable = ISegment | LocalReferencePosition;

Variable Details

MergeTreeDeltaType (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

MergeTreeDeltaType: {
    readonly INSERT: 0;
    readonly REMOVE: 1;
    readonly ANNOTATE: 2;
    readonly GROUP: 3;
}

MergeTreeMaintenanceType (ALPHA)

Enum-like constant defining the types of “maintenance” events on a merge tree. Maintenance events correspond to structural segment changes or acks of pending segments.

Note: these values are assigned negative integers to avoid clashing with MergeTreeDeltaType.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

MergeTreeMaintenanceType: {
    readonly APPEND: -1;
    readonly SPLIT: -2;
    readonly UNLINK: -3;
    readonly ACKNOWLEDGED: -4;
}

SlidingPreference (ALPHA)

Dictates the preferential direction for a ReferencePosition to slide in a merge-tree

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

SlidingPreference: {
    readonly BACKWARD: 0;
    readonly FORWARD: 1;
}