TimeInfo

AMD: require(["esri/layers/support/TimeInfo"], (TimeInfo) => { /* code goes here */ });
ESM: import TimeInfo from "@arcgis/core/layers/support/TimeInfo";
Class: esri/layers/support/TimeInfo
Inheritance: TimeInfo Accessor
Since: ArcGIS Maps SDK for JavaScript 4.11

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

new TimeInfo(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

The name of the field containing the end time information.

more details
TimeInfo
TimeExtent

The time extent defines the start time and end time for all data in the layer.

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
TimeInfo
String

The name of the field containing the start time information.

more details
TimeInfo
TimeReference

Defines information about daylight savings time and the time zone in which data was collected.

more details
TimeInfo
String

The name of the field used to join or group discrete locations.

more details
TimeInfo

Property Details

declaredClass Stringreadonly inherited

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 TimeExtentautocast
Since: ArcGIS Maps SDK 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.");
Since: ArcGIS Maps SDK 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.

timeReference TimeReferenceautocast
Since: ArcGIS Maps SDK for JavaScript 4.24

Defines information about daylight savings time and the time zone in which data was collected.

Default Value:null
trackIdField String
Since: ArcGIS Maps SDK for JavaScript 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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
TimeInfo

Creates a deep clone of TimeInfo object.

more details
TimeInfo
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
TimeInfo
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
TimeInfo

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

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

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.