IMergeTreeAnnotateMsg Interface
Packages > @fluidframework/merge-tree > IMergeTreeAnnotateMsg
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 IMergeTreeAnnotateMsg extends IMergeTreeDelta
Extends: IMergeTreeDelta
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
pos1 | Alpha |
optional |
number | |
pos2 | Alpha |
optional |
number | |
props | Alpha |
Record<string, any> | ||
relativePos1 | Alpha |
optional |
IRelativePosition | |
relativePos2 | Alpha |
optional |
IRelativePosition | |
type | Alpha |
typeof MergeTreeDeltaType.ANNOTATE |
Property Details
pos1
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
pos1?: number;
Type: number
pos2
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
pos2?: number;
Type: number
props
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
props: Record<string, any>;
Type: Record<string, any>
relativePos1
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
relativePos1?: IRelativePosition;
Type: IRelativePosition
relativePos2
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
relativePos2?: IRelativePosition;
Type: IRelativePosition
type
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
type: typeof MergeTreeDeltaType.ANNOTATE;
Type: typeof MergeTreeDeltaType.ANNOTATE