Class UnionRanges

Takes a list of ranges and computes the union ranges on read.

Hierarchy (View Summary)

ReadonlyRangesImpl
- UnionRanges

Index

Constructors

Accessors

empty innerRanges ranges

Methods

[iterator] getRangeAt getRangeContaining getRangesWithin invalidate toString

Constructors

constructor

new UnionRanges(
innerRanges: readonly ReadonlyRanges[],
options?: Maybe<UnionRangesOptions>,
): UnionRanges
Parameters
- innerRanges: readonly ReadonlyRanges[]
  The ranges for which to compute the union.
- Optionaloptions: Maybe<UnionRangesOptions>
Returns UnionRanges
Overrides ReadonlyRangesImpl.constructor
- Defined in util/range/UnionRanges.ts:30

Accessors

empty

get empty(): boolean
Returns true if there are zero ranges.

Returns boolean
Inherited from ReadonlyRangesImpl.empty
- Defined in util/range/Ranges.ts:95

innerRanges

get innerRanges(): readonly ReadonlyRanges[]
Returns readonly ReadonlyRanges[]
- Defined in util/range/UnionRanges.ts:42
set innerRanges(value: readonly ReadonlyRanges[]): void
Parameters
- value: readonly ReadonlyRanges[]
Returns void
- Defined in util/range/UnionRanges.ts:46

ranges

get ranges(): readonly Range[]
An accessor to the backed ranges. Implementations must provide an ArrayLike for random-access reading. This will be called at most once per read operation.

Returns readonly Range[]
Overrides ReadonlyRangesImpl.ranges
- Defined in util/range/UnionRanges.ts:51

Methods

[iterator]

"[iterator]"(): IterableIterator<Range>
Returns IterableIterator<Range>
Inherited from ReadonlyRangesImpl.[iterator]
- Defined in util/range/Ranges.ts:142

getRangeAt

getRangeAt(value: number, tolerance?: number): null | Range
Returns the range at the given value, or null if all ranges are outside the given tolerance. Range values are considered inclusive. That is, a ReadonlyRanges with [0, 1] will return [0, 1] for value 1.
Parameters
- value: number
  The value to compare to current ranges.
- tolerance: number = 0
  The tolerance the value may be outside a range and still considered to be within. Default: 0
Returns null | Range
Inherited from ReadonlyRangesImpl.getRangeAt
- Defined in util/range/Ranges.ts:99

getRangeContaining

getRangeContaining(from: number, to: number, tolerance?: number): null | Range
Returns the range that includes the entire from-to span, within a given tolerance.

Range values are considered inclusive. That is, a ReadonlyRanges with [0, 2] will return [0, 2] for getRangeContaining(2, 2) or getRangeContaining(0, 0).

from does not need to be lesser than to.
Parameters
- from: number
- to: number
- Optionaltolerance: number
Returns null | Range
Inherited from ReadonlyRangesImpl.getRangeContaining
- Defined in util/range/Ranges.ts:112

getRangesWithin

getRangesWithin(from: number, to: number, tolerance?: number): Range[]
Returns all ranges where at least part of the range is within the given from-to span.

from does not need to be lesser than to.
Parameters
- from: number
- to: number
- tolerance: number = 0
Returns Range[]
Inherited from ReadonlyRangesImpl.getRangesWithin
- Defined in util/range/Ranges.ts:126

invalidate

invalidate(): void
Flags the union ranges as invalid. This has no effect if options.useCache is not true.

Returns void
- Defined in util/range/UnionRanges.ts:60

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from ReadonlyRangesImpl.toString
- Defined in util/range/Ranges.ts:146