IRelativePosition Interface
A position specified relative to a segment. \
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 interface IRelativePosition
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
before | Beta |
optional |
boolean | If true, insert before the specified segment. If false or not defined, insert after the specified segment. |
id | Beta |
optional |
string | String identifier specifying a segment. |
offset | Beta |
optional |
number | A positive number >= 1. If before is false, offset is added to the position. If before is true, offset is subtracted from the position. |