TimeIntervalCollectionProperty

new TimeIntervalCollectionProperty()

A Property which is defined by a TimeIntervalCollection, where the data property of each TimeInterval represents the value at time.
Examples:
//Create a Cartesian2 interval property which contains data on August 1st, 2012
//and uses a different value every 6 hours.
var composite = new Cesium.TimeIntervalCollectionProperty();
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T00:00:00.00Z/2012-08-01T06:00:00.00Z', true, false, new Cesium.Cartesian2(2.0, 3.4)));
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T06:00:00.00Z/2012-08-01T12:00:00.00Z', true, false, new Cesium.Cartesian2(12.0, 2.7)));
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T12:00:00.00Z/2012-08-01T18:00:00.00Z', true, false, new Cesium.Cartesian2(5.0, 12.4)));
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T18:00:00.00Z/2012-08-02T00:00:00.00Z', true, true, new Cesium.Cartesian2(85.0, 4.1)));
//Create a TimeIntervalCollectionProperty that contains user-defined objects.
function cloneMyObject(value, result) {
    return {
        value : value.value
    };
}

var myObject = {
    value : 6,
    clone : cloneMyObject
};
var myObject2 = {
    value : 12,
    clone : cloneMyObject
};

var composite = new Cesium.TimeIntervalCollectionProperty();
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T00:00:00.00Z/2012-08-01T06:00:00.00Z', true, false, myObject));
composite.intervals.addInterval(Cesium.TimeInterval.fromIso8601('2012-08-01T06:00:00.00Z/2012-08-01T12:00:00.00Z', true, false, myObject2));
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 57

Members

definitionChanged :Event

Gets the event that is raised whenever the definition of this property changes. The definition is changed whenever setValue is called with data different than the current value.
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 82

intervals :TimeIntervalCollection

Gets the interval collection.
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 93

isConstant :Boolean

Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 70

Methods

equals(other) → Boolean

Compares this property to the provided property and returns true if they are equal, false otherwise.
Name Type Description
other Property optional The other property.
Returns:
true if left and right are equal, false otherwise.
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 132

getValue(time, result) → Object

Gets the value of the property at the provided time.
Name Type Description
time JulianDate The time for which to retrieve the value.
result Object optional The object to store the value into, if omitted, a new instance is created and returned.
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
Throws:
  • DeveloperError : This value requires a clone function be specified for the TimeIntervalCollectionProperty constructor.
Source: DynamicScene/TimeIntervalCollectionProperty.js, line 110