Interval Class

Packages > @fluidframework/sequence > Interval

Signature:

export declare class Interval implements ISerializableInterval

Implements: ISerializableInterval

Constructors

List of constructors for this class
Constructor	Modifiers	Description
(constructor)(start, end, props)		Constructs a new instance of the `Interval` class

Properties

List of properties for this class
Property	Modifiers	Type	Description
auxProps		MergeTree.PropertySet[]
end		number
properties		MergeTree.PropertySet
start		number

Methods

List of methods on this class
Method	Modifiers	Description
addProperties(newProps, op)
addPropertySet(props)
clone()
compare(b)
getAdditionalPropertySets()
getProperties()
overlaps(b)
serialize(client)
union(b)

Constructors

Interval.(constructor)

Constructs a new instance of the Interval class

Signature:

constructor(start: number, end: number, props?: MergeTree.PropertySet);

Parameters

List of parameters
Parameter	Type	Description
start	number
end	number
props	MergeTree.PropertySet

Properties

auxProps

Signature:

auxProps: MergeTree.PropertySet[];

end

Signature:

end: number;

properties

Signature:

properties: MergeTree.PropertySet;

start

Signature:

start: number;

Methods

addProperties

Signature:

addProperties(newProps: MergeTree.PropertySet, op?: MergeTree.ICombiningOp): void;

Parameters

List of parameters
Parameter	Type	Description
newProps	MergeTree.PropertySet
op	MergeTree.ICombiningOp

Returns:

void

addPropertySet

Signature:

addPropertySet(props: MergeTree.PropertySet): void;

Parameters

List of parameters
Parameter	Type	Description
props	MergeTree.PropertySet

Returns:

void

clone

Signature:

clone(): Interval;

Returns:

Interval

compare

Signature:

compare(b: Interval): number;

Parameters

List of parameters
Parameter	Type	Description
b	Interval

Returns:

number

getAdditionalPropertySets

Signature:

getAdditionalPropertySets(): MergeTree.PropertySet[];

Returns:

MergeTree.PropertySet[]

getProperties

Signature:

getProperties(): MergeTree.PropertySet;

Returns:

MergeTree.PropertySet

overlaps

Signature:

overlaps(b: Interval): boolean;

Parameters

List of parameters
Parameter	Type	Description
b	Interval

Returns:

boolean

serialize

Signature:

serialize(client: MergeTree.Client): ISerializedInterval;

Parameters

List of parameters
Parameter	Type	Description
client	MergeTree.Client

Returns:

ISerializedInterval

union

Signature:

union(b: Interval): Interval;

Parameters

List of parameters
Parameter	Type	Description
b	Interval

Returns:

Interval