IMergeTreeAnnotateMsg Interface
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 |
|---|---|---|---|---|
| adjust | Beta | optional | never | |
| pos1 | Beta | optional | number | |
| pos2 | Beta | optional | number | |
| props | Beta | Record<string, any> | ||
| relativePos1 | Beta | optional | IRelativePosition | |
| relativePos2 | Beta | optional | IRelativePosition | |
| type | Beta | typeof MergeTreeDeltaType.ANNOTATE |
Property Details
adjust
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
adjust?: never;
Type: never
pos1
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
pos1?: number;
Type: number
pos2
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
pos2?: number;
Type: number
props
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
props: Record<string, any>;
Type: Record<string, any>
relativePos1
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
relativePos1?: IRelativePosition;
Type: IRelativePosition
relativePos2
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
relativePos2?: IRelativePosition;
Type: IRelativePosition
type
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
type: typeof MergeTreeDeltaType.ANNOTATE;
Type: typeof MergeTreeDeltaType.ANNOTATE