TimeIntervalCollection

Members

changedEvent :Event

Gets an event that is raised whenever the collection of intervals change.

empty :Boolean

Returns true if the collection is empty, false otherwise.

length :Number

Gets the number of intervals in the collection.

start :JulianDate

Gets the start date of the collection.

stop :JulianDate

Gets the stop date of the collection.

Methods

addInterval

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.

Parameters:

Name	Type	Argument	Description
interval	TimeInterval		The interval to add.
equalsCallback	Function	<optional>	An optional function which takes the data from two TimeIntervals and returns true if they are equal, false otherwise. If this function is not provided, the Javascript equality operator is used.

clear

Clears the collection.

contains

Returns true if the specified date is contained in the interval collection.

Parameters:

Name	Type	Description
date	JulianDate	The date to search for.

Returns:

True if the specified date is contained in the interval collection, undefined otherwise.

equals

Compares the provided TimeIntervalCollections and returns true if they are equal, false otherwise.

Parameters:

Name	Type	Argument	Description
right	TimeInterval	<optional>	The right hand side collection.
dataComparer	Function	<optional>	A function which compares the data for each interval in the collection. If ommitted, reference equality is used.

Returns:

Boolean true if left and right are equal, false otherwise.

findDataForIntervalContainingDate

Returns the data for the interval which contains the specified date.

Parameters:

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.

findInterval

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.

Parameters:

Name	Type	Argument	Description
start	JulianDate	<optional>	The start of the interval.
stop	JulianDate	<optional>	The end of the interval.
isStartIncluded	JulianDate	<optional>	True if the start date is included.
isStopIncluded	JulianDate	<optional>	True if the stop date is included.

Returns:

The first interval in the collection that matches the specified parameters.

findIntervalContainingDate

Returns the interval which contains the specified date.

Parameters:

Name	Type	Description
date	JulianDate	The date to search for.

Returns:

The interval containing the specified date, undefined if no such interval exists.

get

Gets the interval at the specified index.

Parameters:

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

Throws:

DeveloperError : index must be a number.

Returns:

TimeInterval The TimeInterval at the specified index, or undefined if no such index exists.

indexOf

Returns the index of the interval in the collection that contains the specified date.

Parameters:

Name	Type	Description
date	JulianDate	The date to search for.

Returns:

The index of the interval which 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.

intersect

Creates a new TimeIntervalCollection which is the intersection of this collection and the provided collection.

Parameters:

Name	Type	Argument	Description
timeIntervalCollection	TimeIntervalCollection		The collection to intersect with.
equalsCallback	Function	<optional>	An optional function which takes the data from two TimeIntervals and returns true if they are equal, false otherwise. If this function is not provided, the Javascript equality operator is used.
mergeCallback	Function	<optional>	An optional function which takes the data from two TimeIntervals and returns a merged version of the data. If this parameter is omitted, the interval data from this collection will be used.

Returns:

A new TimeIntervalCollection which is the intersection of this collection and the provided collection.

intersectInterval

Creates a new TimeIntervalCollection which is the intersection of this collection and the provided interval.

Parameters:

Name	Type	Argument	Description
interval	TimeInterval		The interval to intersect with.
equalsCallback	Function	<optional>	An optional function which takes the data from two TimeIntervals and returns true if they are equal, false otherwise. If this function is not provided, the equality operator will be used.
mergeCallback	Function	<optional>	An optional function which takes the data from two TimeIntervals and returns a merged version of the data. If this parameter is omitted, the interval data from this collection will be used.

Returns:

A new TimeIntervalCollection which is the intersection of this collection and the provided collection.

removeInterval

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

Parameters:

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.