ReferenceType
Packages > @fluidframework/merge-tree > ReferenceType
Flags enum that dictates behavior of a ReferencePosition
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here .
Signature
export declare enum ReferenceType
Flags
| Flag | Alerts | Description |
|---|---|---|
| RangeBegin | Alpha |
Denotes that this reference begins the start of an interval. This is generally not meaningful outside the context of interval collections on SharedString. |
| RangeEnd | Alpha |
Denotes that this reference is the end of an interval. This is generally not meaningful outside the context of interval collections on SharedString. |
| Simple | Alpha |
|
| SlideOnRemove | Alpha |
When a segment is marked removed (locally or with ack), this reference will slide to the first valid option of: 1. the start of the next furthest segment 2. the end of the next nearest segment 3. DetachedReferencePosition |
| StayOnRemove | Alpha |
When a segment is marked removed (locally or with ack), this reference will remain on that segment. |
| Tile | Alpha |
Allows this reference to be located using the searchForMarker API on merge-tree. |
| Transient | Alpha |
Specifies that the reference position should never be added to the segment it refers to. This is useful for comparison/iteration purposes |
RangeBegin
Denotes that this reference begins the start of an interval. This is generally not meaningful outside the context of interval collections on SharedString.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
RangeBegin = 16
RangeEnd
Denotes that this reference is the end of an interval. This is generally not meaningful outside the context of interval collections on SharedString.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
RangeEnd = 32
Simple
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
Simple = 0
SlideOnRemove
When a segment is marked removed (locally or with ack), this reference will slide to the first valid option of: 1. the start of the next furthest segment 2. the end of the next nearest segment 3. DetachedReferencePosition
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
SlideOnRemove = 64
StayOnRemove
When a segment is marked removed (locally or with ack), this reference will remain on that segment.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
StayOnRemove = 128
Tile
Allows this reference to be located using the searchForMarker API on merge-tree.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
Tile = 1
Transient
Specifies that the reference position should never be added to the segment it refers to. This is useful for comparison/iteration purposes
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
Transient = 256