BaseSegment Class

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 declare abstract class BaseSegment implements ISegment

Implements: ISegment

Constructors

Constructor	Alerts	Description
(constructor)(properties)	Alpha	Constructs a new instance of the BaseSegment class

Properties

Property	Alerts	Modifiers	Type	Description
attribution	Alpha	optional	IAttributionCollection<AttributionKey>
cachedLength	Alpha		number
properties	Alpha	optional	PropertySet
trackingCollection	Alpha	readonly	TrackingGroupCollection
type	Alpha	readonly	string

Constructor Details

(constructor)

Constructs a new instance of the BaseSegment class

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

constructor(properties?: PropertySet);

Parameters

Parameter	Modifiers	Type	Description
properties	optional	PropertySet

Property Details

attribution

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

attribution?: IAttributionCollection<AttributionKey>;

Type: IAttributionCollection<AttributionKey>

cachedLength

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

cachedLength: number;

Type: number

properties

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

properties?: PropertySet;

Type: PropertySet

trackingCollection

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

readonly trackingCollection: TrackingGroupCollection;

Type: TrackingGroupCollection

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

abstract readonly type: string;

Type: string