TimeIntervalCollection - Cesium Documentation

# TimeIntervalCollection

#### new TimeIntervalCollection(intervals)

  A non-overlapping collection of `TimeInterval` instances sorted by start time.

  Name | Type | Description
  --- | --- | ---
  `intervals` | Array.<TimeInterval> | optional An array of intervals to add to the collection.

  Source: Core/TimeIntervalCollection.js, line 33

### Members

#### readonlychangedEvent :Event

  Gets an event that is raised whenever the collection of intervals change.
  Source: Core/TimeIntervalCollection.js, line 52

#### readonlyisEmpty :Boolean

  Gets whether or not the collection is empty.
  Source: Core/TimeIntervalCollection.js, line 130

#### readonlyisStartIncluded :Boolean

  Gets whether or not the start time is included in the collection.
  Source: Core/TimeIntervalCollection.js, line 77

#### readonlyisStopIncluded :Boolean

  Gets whether or not the stop time is included in the collection.
  Source: Core/TimeIntervalCollection.js, line 104

#### readonlylength :Number

  Gets the number of intervals in the collection.
  Source: Core/TimeIntervalCollection.js, line 118

#### readonlystart :JulianDate

  Gets the start time of the collection.
  Source: Core/TimeIntervalCollection.js, line 64

#### readonlystop :JulianDate

  Gets the stop time of the collection.
  Source: Core/TimeIntervalCollection.js, line 90

### Methods

#### addInterval(interval, dataComparer)

  Adds an interval to the collection, merging intervals that contain the same data and splitting intervals of different data as needed in order to maintain a non-overlapping collection. The data in the new interval takes precedence over any existing intervals in the collection.

  Name | Type | Description
  --- | --- | ---
  `interval` | TimeInterval | The interval to add.
  `dataComparer` | TimeInterval~DataComparer | optional A function which compares the data of the two intervals. If omitted, reference equality is used.

  Source: Core/TimeIntervalCollection.js, line 303

#### contains(julianDate) → Boolean

  Checks if the specified date is inside this collection.

  Name | Type | Description
  --- | --- | ---
  `julianDate` | JulianDate | The date to check.

  ##### Returns:

  `true` if the collection contains the specified date, `false` otherwise.
  Source: Core/TimeIntervalCollection.js, line 220

#### equals(right, dataComparer) → Boolean

  Compares this instance against the provided instance componentwise and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | TimeIntervalCollection | optional The right hand side collection.
  `dataComparer` | TimeInterval~DataComparer | optional A function which compares the data of the two intervals. If omitted, reference equality is used.

  ##### Returns:

  `true` if they are equal, `false` otherwise.
  Source: Core/TimeIntervalCollection.js, line 145

#### findDataForIntervalContainingDate(date)

  Finds and returns the data for the interval that contains the specified date.

  Name | Type | Description
  --- | --- | ---
  `date` | JulianDate | The date to search for.

  ##### Returns:

  The data for the interval containing the specified date, or `undefined` if no such interval exists.
  Source: Core/TimeIntervalCollection.js, line 209

#### findInterval(options)

  Returns the first interval in the collection that matches the specified parameters. All parameters are optional and `undefined` parameters are treated as a don't care condition.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Description
  --- | --- | ---
  `start` | JulianDate | optional The start time of the interval.
  `stop` | JulianDate | optional The stop time of the interval.
  `isStartIncluded` | Boolean | optional `true` if `options.start` is included in the interval, `false` otherwise.
  `isStopIncluded` | Boolean | optional `true` if `options.stop` is included in the interval, `false` otherwise.

  ##### Returns:

  The first interval in the collection that matches the specified parameters.
  Source: Core/TimeIntervalCollection.js, line 275

#### findIntervalContainingDate(date)

  Finds and returns the interval that contains the specified date.

  Name | Type | Description
  --- | --- | ---
  `date` | JulianDate | The date to search for.

  ##### Returns:

  The interval containing the specified date, `undefined` if no such interval exists.
  Source: Core/TimeIntervalCollection.js, line 198

#### get(index) → TimeInterval

  Gets the interval at the specified index.

  Name | Type | Description
  --- | --- | ---
  `index` | Number | The index of the interval to retrieve.

  ##### Returns:

  The interval at the specified index, or `undefined` if no interval exists as that index.
  Source: Core/TimeIntervalCollection.js, line 172

#### indexOf(date)

  Finds and returns the index of the interval in the collection that contains the specified date.

  Name | Type | Description
  --- | --- | ---
  `date` | JulianDate | The date to search for.

  ##### Returns:

  The index of the interval that contains the specified date, if no such interval exists, it returns a negative number which is the bitwise complement of the index of the next interval that starts after the date, or if no interval starts after the specified date, the bitwise complement of the length of the collection.
  Source: Core/TimeIntervalCollection.js, line 235

#### intersect(other, dataComparer, mergeCallback)

  Creates a new instance that is the intersection of this collection and the provided collection.

  Name | Type | Description
  --- | --- | ---
  `other` | TimeIntervalCollection | The collection to intersect with.
  `dataComparer` | TimeInterval~DataComparer | optional A function which compares the data of the two intervals. If omitted, reference equality is used.
  `mergeCallback` | TimeInterval~MergeCallback | optional A function which merges the data of the two intervals. If omitted, the data from the left interval will be used.

  ##### Returns:

  A new TimeIntervalCollection which is the intersection of this collection and the provided collection.
  Source: Core/TimeIntervalCollection.js, line 599

#### removeAll()

  Removes all intervals from the collection.
  Source: Core/TimeIntervalCollection.js, line 185

#### removeInterval(interval)

  Removes the specified interval from this interval collection, creating a hole over the specified interval. The data property of the input interval is ignored.

  Name | Type | Description
  --- | --- | ---
  `interval` | TimeInterval | The interval to remove.

  ##### Returns:

  `true` if the interval was removed, `false` if no part of the interval was in the collection.
  Source: Core/TimeIntervalCollection.js, line 453