TimeExtent
require(["esri/TimeExtent"], function(TimeExtent) { /* code goes here */ });esri/TimeExtentA period of time with a definitive start and end date. Time extent is used to display or query features that fall within the specified time period. To represent an instant of time, set the start and end times to the same date.
When creating a JavaScript Date, be mindful that most constructors will create a date with respect to your local timezone rather than UTC (i.e. universal time). To create a date with respect to UTC, use the UTC method on the Date object.
// Represents the data for the month of Jan, 1970
const timeExtent = new TimeExtent({
start: new Date(Date.UTC(1970, 0, 1, 6, 30)),
end: new Date(Date.UTC(1970, 0, 31, 6, 30))
});Constructors
- new TimeExtent(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example:// Typical usage // Represents the data for the month of Jan, 1970 const timeExtent = new TimeExtent({ start: new Date(Date.UTC(1970, 0, 1, 6, 30)), end: new Date(Date.UTC(1970, 0, 31, 6, 30)) });
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Date | The end time of the time extent. more details | more details | TimeExtent | |
| Date | The start time of the time extent. more details | more details | TimeExtent |
Property Details
- end Date
The end time of the time extent.
- Default Value:null
- start Date
The start time of the time extent.
- Default Value:null
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| TimeExtent | Creates a deep clone of TimeExtent object. more details | more details | TimeExtent | |
| TimeExtent | Returns the time extent resulting from the intersection of the current time extent and parsed time extent. more details | more details | TimeExtent |
Method Details
- clone(){TimeExtent}
Creates a deep clone of TimeExtent object.
Returns:Type Description TimeExtent A new instance of a TimeExtent object equal to the object used to call .clone().
- intersection(timeExtent){TimeExtent}Since: ArcGIS API for JavaScript 4.12
Returns the time extent resulting from the intersection of the current time extent and parsed time extent. Returns
nullif two time extents do not intersect.Parameter:timeExtent TimeExtentThe time extent to be intersected with the time extent on which
intersection()is being called on.Returns:Type Description TimeExtent The intersecting time extent between two time extents. Example:// get the intersecting timeExtent between view.timeExtent and // layer view filter's timeExtent const timeExtent = view.timeExtent.intersection(layerView.effect.filter.timeExtent); if (timeExtent){ console.log("time intersection", timeExtent); const query = layerView.createQuery(); query.timeExtent = timeExtent; layerView.queryFeatures(query).then(function(results){ console.log(results.features.length, " are returned for intersecting timeExtent"); }); }