SequenceInterval Class

Packages > fluid-framework > SequenceInterval

Signature:

export declare class SequenceInterval implements ISerializableInterval 

Implements: ISerializableInterval

Constructors

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

Properties

List of properties for this class
Property Modifiers Type Description
end
intervalType IntervalType
properties
propertyManager
start

Methods

List of methods on this class
Method Modifiers Description
addProperties(newProps, collab, seq, op)
clone()
compare(b)
compareEnd(b)
compareStart(b)
getIntervalId()
modify(label, start, end, op)
overlaps(b)
overlapsPos(bstart, bend)
serialize(client)
union(b)

Constructors

SequenceInterval.(constructor)

Constructs a new instance of the SequenceInterval class

Signature:

constructor(start: LocalReference, end: LocalReference, intervalType: IntervalType, props?: PropertySet);

Parameters

List of parameters
Parameter Type Description
start
end
intervalType IntervalType
props

Properties

end

Signature:

end: LocalReference;

intervalType

Signature:

intervalType: IntervalType;

properties

Signature:

properties: PropertySet;

propertyManager

Signature:

propertyManager: PropertiesManager;

start

Signature:

start: LocalReference;

Methods

addProperties

Signature:

addProperties(newProps: PropertySet, collab?: boolean, seq?: number, op?: ICombiningOp): PropertySet | undefined;

Parameters

List of parameters
Parameter Type Description
newProps
collab
seq
op

Returns:

clone

Signature:

clone(): SequenceInterval;

Returns:

SequenceInterval

compare

Signature:

compare(b: SequenceInterval): number;

Parameters

List of parameters
Parameter Type Description
b SequenceInterval

Returns:

compareEnd

Signature:

compareEnd(b: SequenceInterval): number;

Parameters

List of parameters
Parameter Type Description
b SequenceInterval

Returns:

compareStart

Signature:

compareStart(b: SequenceInterval): number;

Parameters

List of parameters
Parameter Type Description
b SequenceInterval

Returns:

getIntervalId

Signature:

getIntervalId(): string | undefined;

Returns:

modify

Signature:

modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage): SequenceInterval;

Parameters

List of parameters
Parameter Type Description
label
start
end
op

Returns:

SequenceInterval

overlaps

Signature:

overlaps(b: SequenceInterval): boolean;

Parameters

List of parameters
Parameter Type Description
b SequenceInterval

Returns:

overlapsPos

Signature:

overlapsPos(bstart: number, bend: number): boolean;

Parameters

List of parameters
Parameter Type Description
bstart
bend

Returns:

serialize

Signature:

serialize(client: Client): ISerializedInterval;

Parameters

List of parameters
Parameter Type Description
client

Returns:

ISerializedInterval

union

Signature:

union(b: SequenceInterval): SequenceInterval;

Parameters

List of parameters
Parameter Type Description
b SequenceInterval

Returns:

SequenceInterval