Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/layers/support/TimeInfo"], function(TimeInfo) { /* code goes here */ });
Class: esri/layers/support/TimeInfo
Inheritance: TimeInfo Accessor
Since: ArcGIS API 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The name of the field containing the end time information.

more details
more detailsTimeInfo
TimeExtent

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

more details
more detailsTimeInfo
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 detailsTimeInfo
String

The name of the field containing the start time information.

more details
more detailsTimeInfo

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 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.");
Since: 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

NameReturn TypeSummaryClass
TimeInfo

Creates a deep clone of TimeInfo object.

more details
more detailsTimeInfo
*

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 detailsTimeInfo
Object

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

more details
more detailsTimeInfo

Method Details

clone(){TimeInfo}

Creates a deep clone of TimeInfo object.

Returns:
TypeDescription
TimeInfoA 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 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...