Packages > @fluidframework/merge-tree > LocalReferencePosition

LocalReferencePosition 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

/** @sealed */
export interface LocalReferencePosition extends ReferencePosition

Extends: ReferencePosition

Properties

Property Alerts Modifiers Type Description
callbacks Alpha optional Partial<Record<"beforeSlide" | "afterSlide", (ref: LocalReferencePosition) => void>>
canSlideToEndpoint Alpha optional, readonly boolean Whether or not this reference position can slide onto one of the two special segments representing the position before or after the tree
trackingCollection Alpha readonly TrackingGroupCollection

Property Details

callbacks

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

callbacks?: Partial<Record<"beforeSlide" | "afterSlide", (ref: LocalReferencePosition) => void>>;

Type: Partial<Record<“beforeSlide” | “afterSlide”, (ref: LocalReferencePosition ) => void>>

canSlideToEndpoint

Whether or not this reference position can slide onto one of the two special segments representing the position before or after the 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

readonly canSlideToEndpoint?: boolean;

Type: boolean

trackingCollection

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

readonly trackingCollection: TrackingGroupCollection;

Type: TrackingGroupCollection