Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: TimeExtent
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.TimeExtent")
Description
(Added at v2.0)
The time extent is a span of time going from a start time to an end time. To represent an instant in time set the startTime and endTime to the same time value. The TimeExtent is returned in the metadata for time-aware services and layers. It is often used to create a TimeSlider ranging from a start time to an end time.
See also
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new esri.TimeExtent(startTime, endTime) | Creates a new TimeExtent object with the specifed start and end time. |
Properties
| Name | Type | Summary |
|---|---|---|
| endTime | Date | The end time for the specified time extent. |
| startTime | Date | The start time for the specified time extent. |
Methods
| Name | Return type | Summary |
|---|---|---|
| intersection(timeExtent) | TimeExtent | Returns a new time extent indicating the intersection between "this" and the argument time extent. |
| offset(offsetValue, offsetUnits) | TimeExtent | Returns a new time extent with the given offset from "this' time extent. |
Constructor Details
Creates a new TimeExtent object with the specifed start and end time. If the startTime is null or undefined the start time is negative infinity. If the endTime is null or undefined the endTime is positive infinity. To represent an instant in time set the startTime and endTime to the same time value.
Parameters:
< |
Required | The start time for the specified time extent. |
< |
Required | The end time for the specified time extent. |
Sample:
var timeExtent = new esri.TimeExtent(new Date("10/16/2000"),new Date("10/18/2000"));
Property Details
<Date
DateThe end time for the specified time extent.
Sample:
timeExtent.endTime = new Date("12/31/1992 UTC");
<Date
DateThe start time for the specified time extent.
Sample:
timeExtent.startTime = new Date("1/1/1989 UTC");
Method Details
Returns a new time extent indicating the intersection between "this" and the argument time extent.
Return type:
TimeExtentParameters:
< |
Required | The input time extent. |
Returns a new time extent with the given offset from "this' time extent.
Return type:
TimeExtent