import TimeInfo from "@arcgis/core/layers/support/TimeInfo.js";const TimeInfo = await $arcgis.import("@arcgis/core/layers/support/TimeInfo.js");- 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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
TimeExtent | null | undefined | | |
| | ||
| | ||
| | ||
| | ||
| |
endField
The name of the field containing the end time information. This field can be date, date-only or timestamp-offset
field type for FeatureLayer
and MapImageLayer.
fullTimeExtent
- Type
- TimeExtent | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.12
The time extent defines the start time and end time for all data in the layer.
Example
const { start, end } = featureLayer.timeInfo.fullTimeExtent;const range = end - start; // millisecondsconst days = range / ( 1000 * 60 * 60 * 24 ); // daysconsole.log(`The layer's temporal extent is ${days} days.`); interval
- Type
- TimeInterval | null | undefined
- 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
The name of the field containing the start time information. This field can be date, date-only or timestamp-offset
field type for FeatureLayer
and MapImageLayer.
timeZone
- Since
- ArcGIS Maps SDK for JavaScript 4.28
The IANA time zone that dates are stored in. This only applies to startField and endField.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): this
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.
- Returns
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.