IOverlappingIntervalsIndex Interface
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/sequence/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval>
Extends: IntervalIndex<TInterval>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TInterval | ISerializableInterval |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| findOverlappingIntervals(start, end) | Alpha |
TInterval[] | |
| gatherIterationResults(results, iteratesForward, start, end) | Alpha |
void | Gathers the interval results based on specified parameters. |
Method Details
findOverlappingIntervals
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
findOverlappingIntervals(start: SequencePlace, end: SequencePlace): TInterval[];
Parameters
| Parameter | Type | Description |
|---|---|---|
| start | SequencePlace | |
| end | SequencePlace |
Returns
an array of all intervals contained in this collection that overlap the range [start end].
Return type: TInterval[]
gatherIterationResults
Gathers the interval results based on specified parameters.
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
gatherIterationResults(results: TInterval[], iteratesForward: boolean, start?: SequencePlace, end?: SequencePlace): void;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| results | TInterval[] | ||
| iteratesForward | boolean | ||
| start | optional | SequencePlace | |
| end | optional | SequencePlace |