TimeInfo
require(["esri/layers/support/TimeInfo"], function(TimeInfo) { /* code goes here */ });esri/layers/support/TimeInfoTime info represents the temporal data of a time-aware layer. The time info class provides information such as date fields that store the start and end times for each feature and the total time span for the layer.
Temporal data is data that represents a state in time. You can to step through periods of time to reveal patterns and trends in your data. With temporal data, you can visualize and analyze:
- Moving objects (e.g. planes, satellites, storms),
- Events (e.g. accidents or earthquakes),
- Sensor data (e.g. stream gauges, weather station readings), or
- Variable characteristics (e.g. national or regional population).
Constructors
- new TimeInfo(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | The name of the field containing the end time information. more details | more details | TimeInfo | |
| TimeExtent | The time extent defines the start time and end time for all data in the layer. more details | more details | TimeInfo | |
| TimeInterval | The time interval defines the granularity of the temporal data and allows you to visualize the data at specified intervals using the time slider widget. more details | more details | TimeInfo | |
| String | The name of the field containing the start time information. more details | more details | TimeInfo |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
- endField String
The name of the field containing the end time information.
- fullTimeExtent TimeExtentautocastSince: ArcGIS API for JavaScript 4.12
The time extent defines the start time and end time for all data in the layer.
- Default Value:null
Example:const start = featureLayer.timeInfo.fullTimeExtent.start; const end = featureLayer.timeInfo.fullTimeExtent.end; const range = end - start; // milliseconds const days = range / ( 1000 * 60 * 60 * 24 ); // days console.log("The layer temporal extent is", days, "days.");
- interval TimeIntervalautocastSince: ArcGIS API for JavaScript 4.12
The time interval defines the granularity of the temporal data and allows you to visualize the data at specified intervals using the time slider widget. Usually temporal data is collected at regular intervals such as every hour or every day.
- startField String
The name of the field containing the start time information.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| TimeInfo | Creates a deep clone of TimeInfo object. more details | more details | TimeInfo | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | TimeInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | TimeInfo |
Method Details
- clone(){TimeInfo}
Creates a deep clone of TimeInfo object.
Returns:Type Description TimeInfo A new instance of a TimeInfo object equal to the object used to call .clone().
- 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
jsonparameter 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 ObjectA 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.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.