require(["esri/layers/support/TimeInfo"], (TimeInfo) => { /* code goes here */ });
import TimeInfo from "@arcgis/core/layers/support/TimeInfo.js";
esri/layers/support/TimeInfo
Time 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The name of the field containing the end time information. | TimeInfo | ||
The time extent defines the start time and end time for all data in the layer. | TimeInfo | ||
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. | TimeInfo | ||
The name of the field containing the start time information. | TimeInfo | ||
Indicates the time instants that the layer has data for. | TimeInfo | ||
The IANA time zone that dates are stored in. | TimeInfo | ||
The name of the field used to join or group discrete locations. | TimeInfo |
Property Details
-
endField
endField String
-
The name of the field containing the end time information. This field can be
date
,date-only
ortimestamp-offset
field type for FeatureLayer and MapImageLayer.
-
fullTimeExtent
fullTimeExtent TimeExtentautocast
Since: ArcGIS Maps SDK for JavaScript 4.12TimeInfo since 4.11, fullTimeExtent added at 4.12. -
The time extent defines the start time and end time for all data in the layer.
- Default Value:null
Exampleconst { start, end } = featureLayer.timeInfo.fullTimeExtent; const range = end - start; // milliseconds const days = range / ( 1000 * 60 * 60 * 24 ); // days console.log(`The layer's temporal extent is ${days} days.`);
-
interval
interval TimeIntervalautocast
Since: ArcGIS Maps SDK for JavaScript 4.12TimeInfo since 4.11, interval added at 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
startField String
-
The name of the field containing the start time information. This field can be
date
,date-only
ortimestamp-offset
field type for FeatureLayer and MapImageLayer.
-
Since: ArcGIS Maps SDK for JavaScript 4.30TimeInfo since 4.11, stops added at 4.30. -
Indicates the time instants that the layer has data for. Used in place of interval, etc.
- Default Value:null
-
timeZone
timeZone String
Since: ArcGIS Maps SDK for JavaScript 4.28TimeInfo since 4.11, timeZone added at 4.28. -
The IANA time zone that dates are stored in. This only applies to startField and endField.
- Default Value:null
- See also
-
trackIdField
trackIdField String
Since: ArcGIS Maps SDK for JavaScript 4.15TimeInfo since 4.11, trackIdField added at 4.15. -
The name of the field used to join or group discrete locations. For example, for hurricane tracks, trackIdField can be the hurricane name field.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
this | Creates a deep clone of this object. | TimeInfo | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TimeInfo | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TimeInfo |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.