SequenceInterval Class
Signature
export declare class SequenceInterval implements ISerializableInterval
Implements: ISerializableInterval
Constructors
| Constructor | Description |
|---|---|
| (constructor)(start, end, intervalType, props) | Constructs a new instance of the SequenceInterval class |
Properties
| Property | Type | Description |
|---|---|---|
| end | LocalReference | |
| intervalType | IntervalType | |
| properties | PropertySet | |
| propertyManager | PropertiesManager | |
| start | LocalReference |
Methods
| Method | Return Type | Description |
|---|---|---|
| addProperties(newProps, collab, seq, op) | PropertySet | undefined | |
| clone() | SequenceInterval | |
| compare(b) | number | |
| compareEnd(b) | number | |
| compareStart(b) | number | |
| getIntervalId() | string | undefined | |
| modify(label, start, end, op) | SequenceInterval | |
| overlaps(b) | boolean | |
| overlapsPos(bstart, bend) | boolean | |
| serialize(client) | ISerializedInterval | |
| union(b) | SequenceInterval |
Constructor Details
(constructor)
Constructs a new instance of the SequenceInterval class
Signature
constructor(start: LocalReference, end: LocalReference, intervalType: IntervalType, props?: PropertySet);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| start | LocalReference | ||
| end | LocalReference | ||
| intervalType | IntervalType | ||
| props | optional | PropertySet |
Property Details
end
Signature
end: LocalReference;
Type: LocalReference
intervalType
Signature
intervalType: IntervalType;
Type: IntervalType
properties
Signature
properties: PropertySet;
Type: PropertySet
propertyManager
Signature
propertyManager: PropertiesManager;
Type: PropertiesManager
start
Signature
start: LocalReference;
Type: LocalReference
Method Details
addProperties
Signature
addProperties(newProps: PropertySet, collab?: boolean, seq?: number, op?: ICombiningOp): PropertySet | undefined;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| newProps | PropertySet | ||
| collab | optional | boolean | |
| seq | optional | number | |
| op | optional | ICombiningOp |
Returns
Return type: PropertySet | undefined
clone
Signature
clone(): SequenceInterval;
Returns
Return type: SequenceInterval
compare
Signature
compare(b: SequenceInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | SequenceInterval |
Returns
Return type: number
compareEnd
Signature
compareEnd(b: SequenceInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | SequenceInterval |
Returns
Return type: number
compareStart
Signature
compareStart(b: SequenceInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | SequenceInterval |
Returns
Return type: number
getIntervalId
Signature
getIntervalId(): string | undefined;
Returns
Return type: string | undefined
modify
Signature
modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage): SequenceInterval;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| label | string | ||
| start | number | ||
| end | number | ||
| op | optional | ISequencedDocumentMessage |
Returns
Return type: SequenceInterval
overlaps
Signature
overlaps(b: SequenceInterval): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | SequenceInterval |
Returns
Return type: boolean
overlapsPos
Signature
overlapsPos(bstart: number, bend: number): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| bstart | number | |
| bend | number |
Returns
Return type: boolean
serialize
Signature
serialize(client: Client): ISerializedInterval;
Parameters
| Parameter | Type | Description |
|---|---|---|
| client | Client |
Returns
Return type: ISerializedInterval
union
Signature
union(b: SequenceInterval): SequenceInterval;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | SequenceInterval |
Returns
Return type: SequenceInterval