DifferenceMove Interface
Represents a move operation between two branches of a tree. Meaning that an object (shared tree node) was identified as being moved from one index to another based on its unique id.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface DifferenceMove
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| newIndex | Alpha |
number | ||
| objectId | Alpha |
optional |
string | number | undefined | |
| path | Alpha |
ObjectPath | ||
| type | Alpha |
"MOVE" | ||
| value | Alpha |
unknown |
Property Details
newIndex
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
newIndex: number;
Type: number
objectId
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
objectId?: string | number | undefined;
Type: string | number | undefined
path
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
path: ObjectPath;
Type: ObjectPath
type
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
type: "MOVE";
Type: "MOVE"
value
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
value: unknown;
Type: unknown