// 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

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

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

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().

expandTo(unit){TimeExtent}

Since: ArcGIS API for JavaScript 4.18

Expands the TimeExtent so that the start and end dates are rounded down and up, respectively, to the parsed time unit.

Parameter:

unit String The time unit to align the start and end dates. Possible Values:"milliseconds"|"seconds"|"minutes"|"hours"|"days"|"weeks"|"months"|"years"|"decades"|"centuries"

Returns:

Type	Description
TimeExtent	A new expanded TimeExtent.

See also:

• Sample - TimeSlider widget

Examples:

// Expand a time extent to a decade.
const extent = new TimeExtent({
  start: new Date(2012, 3, 5),
  end: new Date(2019, 0, 4)
});
const decade = extent.expandTo("decades");
// decade is: 1/1/2010 to 1/1/2020

// Expand a time extent to the nearest month.
const extent = new TimeExtent({
  start: new Date(2012, 3, 5),
  end: new Date(2019, 0, 4)
});
const expandToMonth = extent.expandTo("months");
// expandToMonth is: 4/1/2012 to 2/1/2019

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

intersection(timeExtent){TimeExtent}

Since: ArcGIS API for JavaScript 4.12

Returns the time extent resulting from the intersection of a given time extent and parsed time extent. Returns a timeExtent with undefined values for start and end properties if the two time extents do not intersect.

Parameter:

timeExtent TimeExtent The 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");
  });
}

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

union(timeExtent){TimeExtent}

Since: ArcGIS API for JavaScript 4.18

Returns the time extent resulting from the union of the current time extent and a given time extent.

Parameter:

timeExtent TimeExtent The time extent to be unioned with.

Returns:

Type	Description
TimeExtent	The resulting union of the current time extent and the given time extent.

Example:

// Return the union of two time extents. One from 1990 to 2000 and the second from 2010 to 2020.
const decade1 = new TimeExtent({
  start: new Date(1990, 0, 1),
  end: new Date(2000, 0, 1)
});
const decade2 = new TimeExtent({
  start: new Date(2010, 0, 1),
  end: new Date(2020, 0, 1)
});
const union = decade1.union(decade2);
console.log(`The unioned extent starts from year ${union.start.getFullYear()} to ${union.end.getFullYear()}`);
// output: "The unioned extent starts from year 1990 to 2020"