IInterval Interface
Signature
export interface IInterval
Methods
| Method | Return Type | Description |
|---|---|---|
| clone() | IInterval | |
| compare(b) | number | |
| compareEnd(b) | number | |
| compareStart(b) | number | |
| modify(label, start, end, op) | IInterval | undefined | |
| overlaps(b) | boolean | |
| union(b) | IInterval |
Method Details
clone
Signature
clone(): IInterval;
Returns
Return type: IInterval
compare
Signature
compare(b: IInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | IInterval |
Returns
Return type: number
compareEnd
Signature
compareEnd(b: IInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | IInterval |
Returns
Return type: number
compareStart
Signature
compareStart(b: IInterval): number;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | IInterval |
Returns
Return type: number
modify
Signature
modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage): IInterval | undefined;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| label | string | ||
| start | number | ||
| end | number | ||
| op | optional | ISequencedDocumentMessage |
Returns
Return type: IInterval | undefined
overlaps
Signature
overlaps(b: IInterval): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | IInterval |
Returns
Return type: boolean
union
Signature
union(b: IInterval): IInterval;
Parameters
| Parameter | Type | Description |
|---|---|---|
| b | IInterval |
Returns
Return type: IInterval