require(["esri/layers/support/TrackInfo"], (TrackInfo) => { /* code goes here */ });
import TrackInfo from "@arcgis/core/layers/support/TrackInfo.js";
esri/layers/support/TrackInfo
TrackInfo provides information about how to display and analyze temporal data in a layer. This information includes how to render the latest observations, previous observations, and track lines. It also includes information about how to aggregate data and display popups. TrackInfo is used in the StreamLayer and FeatureLayer classes.
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 | ||
Indicates whether the track info is enabled. | TrackInfo | ||
An array of aggregate fields that summarize layer.fields in all observations of the track. | TrackInfo | ||
Configuration properties for displaying the latest observations. | TrackInfo | ||
The maximum age of displayed observations. | TrackInfo | ||
The maximum number of observations to display per track. | TrackInfo | ||
Indicates whether to display the popup for the track as defined in the popupTemplate. | TrackInfo | ||
The PopupTemplate to apply to the track. | TrackInfo | ||
Configuration properties for displaying previous observations. | TrackInfo | ||
Indicates which field from the layer's timeInfo will be used to calculate observation ages for trackInfo.maxDisplayDuration. | TrackInfo | ||
Configuration properties for displaying track lines. | TrackInfo |
Property Details
-
enabled
enabled Boolean
-
Indicates whether the track info is enabled.
- Default Value:true
ExampletrackInfo.enabled = false;
-
fields
fields AggregateField[]autocast
-
An array of aggregate fields that summarize layer.fields in all observations of the track. Only visible observations are included in the aggregated data. Observations filtered out because of maxDisplayObservations or maxDisplayDuration are excluded from any aggregate field calculations.
These fields may only be used by the popupTemplate, and by the labelingInfo and renderer of trackLines.
Example// Based on the fields in the layer, the following track info fields // could be defined: trackInfo.fields = [{ name: "total_observations", statisticType: "count" }, { name: "AVG_speed", onStatisticField: "speed", statisticType: "avg" }];
-
latestObservations
latestObservations TrackPartInfoautocast
-
Configuration properties for displaying the latest observations.
ExampletrackInfo.latestObservations = { renderer: { type: "simple", symbol: { type: "simple-marker", style: "circle", color: "red", size: 10 } } };
-
maxDisplayDuration
maxDisplayDuration TimeInterval |null |undefinedautocast
-
The maximum age of displayed observations. Observations older than this will not be displayed. Age is calculated by subtracting the time indicated by trackInfo.timeField from the view.timeExtent.end. For StreamLayer, age is calculated by subtracting the time indicated by trackInfo.timeField from the system time. If no duration is specified, or if its value is 0, then displayed observations will not be limited by age.
- Default Value:null
ExampletrackInfo.maxDisplayDuration = { value: 30, unit: "seconds" };
-
maxDisplayObservationsPerTrack
maxDisplayObservationsPerTrack Number
-
The maximum number of observations to display per track. If the value is 0, no limit will be imposed.
- Default Value:0
ExampletrackInfo.maxDisplayObservationsPerTrack = 10;
-
popupEnabled
popupEnabled Boolean
-
Indicates whether to display the popup for the track as defined in the popupTemplate.
- Default Value:true
ExampletrackInfo.popupEnabled = false;
-
popupTemplate
popupTemplate PopupTemplate |null |undefinedautocast
-
The PopupTemplate to apply to the track. When set, a popupTemplate independent of the layer.popupTemplate is used. This popup can display summary information for each track, such as feature count or any other field defined in fields.
The PopupTemplate may contain one or more Arcade expressions following the specification defined by the Arcade Feature Reduction Popup Profile. Expressions must return a string or a number.
Examplelayer.trackInfo = { fields: [{ name: "avg_speed", alias: "Average speed", onStatisticField: "speed", statisticType: "avg" }, { name: "total_observations", statisticType: "count" }], popupTemplate: { content: [{ type: "text", text: "This track contains <b>{total_observations}</b> features." }, { type: "text", text: "The average speed in this track is <b>{avg_speed}</b>." }], fieldInfos: [{ fieldName: "avg_speed", format: { digitSeparator: true, places: 1 } }] } };
-
previousObservations
previousObservations TrackPartInfoautocast
-
Configuration properties for displaying previous observations.
ExampletrackInfo.previousObservations = { renderer: { type: "simple", symbol: { type: "simple-marker", style: "circle", color: "blue", size: 10 } } };
-
timeField
timeField String
-
Indicates which field from the layer's timeInfo will be used to calculate observation ages for trackInfo.maxDisplayDuration. The
timeReceived
option is the system time when the client received the observation, and is only valid for StreamLayer.Possible Values:"timeReceived" |"startTimeField" |"endTimeField"
- Default Value:"startTimeField"
ExampletrackInfo.timeField = "timeReceived";
-
trackLines
trackLines TrackPartInfoautocast
-
Configuration properties for displaying track lines.
ExampletrackInfo.trackLines = { renderer: { type: "simple", symbol: { type: "simple-line", color: "green", width: 2 } } };
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. | TrackInfo | |
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TrackInfo | ||
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. | TrackInfo |
Method Details
-
Inherited from Accessor
-
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.
Returns
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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
-
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.