Class RangesImpl

constructor

• new RangesImpl(ranges?): RangesImpl

• Parameters

  • ranges: readonly Range[] = []

    The non-normalized ranges to add.

  Returns RangesImpl

  See

  #add

Readonlyranges

empty

• get empty(): boolean

• Returns true if there are zero ranges.

  Returns boolean

[iterator]

• [iterator](): IterableIterator<Range>

• Returns IterableIterator<Range>

add

• add(start, end): void

• Adds the given range to this list. If end is less than start, the range will not be added. Ranges will be merged when there is overlap or touching. Example, add(1, 4); add(2, 5) results in the final ranges: [1, 5]

  Parameters

  • start: number
  • end: number

  Returns void

clear

• clear(): void

• Clears all ranges.

  Returns void

clone

• clone(): RangesImpl

• Returns RangesImpl

getRangeAt

• getRangeAt(value, tolerance?): 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

getRangeContaining

• getRangeContaining(from, to, tolerance?): 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

getRangesWithin

• getRangesWithin(from, to, tolerance?): 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
  • Optionaltolerance: number

  Returns Range[]

remove

• remove(start, end): void

• Removes the given range span from this list. Ranges partially intersecting will be changed to not include the start-end span. If start is after end, nothing will be removed.

  Parameters

  • start: number
  • end: number

  Returns void

toString

• toString(): string

• Returns a string representation of an object.

  Returns string