Skip to main content

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
clientId Alpha number
index Alpha number
localMovedSeq Alpha optional number
localRefs Alpha optional LocalReferenceCollection
localRemovedSeq Alpha optional number
localSeq Alpha optional number
movedClientIds Alpha optional number[]
movedSeq Alpha optional number
movedSeqs Alpha optional number[]
ordinal Alpha string
properties Alpha optional PropertySet
removedClientIds Alpha optional number[]
removedSeq Alpha optional number
seq Alpha number
trackingCollection Alpha readonly TrackingGroupCollection
type Alpha readonly string
wasMovedOnInsert Alpha optional boolean | undefined

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

clientId​

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​

clientId: number;

Type: number

index​

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​

index: number;

Type: number

localMovedSeq​

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​

localMovedSeq?: number;

Type: number

localRefs​

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​

localRefs?: LocalReferenceCollection;

Type: LocalReferenceCollection

localRemovedSeq​

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​

localRemovedSeq?: number;

Type: number

localSeq​

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​

localSeq?: number;

Type: number

movedClientIds​

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​

movedClientIds?: number[];

Type: number[]

movedSeq​

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​

movedSeq?: number;

Type: number

movedSeqs​

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​

movedSeqs?: number[];

Type: number[]

ordinal​

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​

ordinal: string;

Type: string

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

removedClientIds​

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​

removedClientIds?: number[];

Type: number[]

removedSeq​

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​

removedSeq?: number;

Type: number

seq​

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​

seq: number;

Type: number

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

wasMovedOnInsert​

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​

wasMovedOnInsert?: boolean | undefined;

Type: boolean | undefined