require(["esri/layers/support/TrackPartInfo"], (TrackPartInfo) => { /* code goes here */ });
import TrackPartInfo from "@arcgis/core/layers/support/TrackPartInfo.js";
esri/layers/support/TrackPartInfo
TrackPartInfo provides information about how to render and label temporal data in a layer. This information includes how to render the latest observations, previous observations, and track lines.
- See also
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 | ||
Defines labels for the track part as an array of LabelClass. | TrackPartInfo | ||
Indicates whether to display labels for the track. | TrackPartInfo | ||
The renderer used to style the track part. | TrackPartInfo | ||
Indicates whether the renderer of the track part is visible. | TrackPartInfo |
Property Details
-
labelingInfo
labelingInfo LabelClass[] |null |undefinedautocast
-
Defines labels for the track part as an array of LabelClass. When set, labels independent of the layer.labelingInfo are used to convey information about the track.
Any aggregate field defined in trackInfo.fields can be referenced in the label.
Multiple Label classes with different
where
clauses can be used to define several labels with varying styles on the same track part. Likewise, multiple label classes may be used to label different types of track parts (e.g. green labels for fast observations and red labels for slow observations).Example// Displays the observation count of the track layer.trackInfo = { fields: [{ name: "total_observations", statisticType: "count" }], trackLines: { labelingInfo: [{ labelExpressionInfo: { expression: "$feature.total_observations" }, symbol: { type: "text", color: "white", font: { size: "12px" }, haloSize: 1, haloColor: "black" } }] } };
-
labelsVisible
labelsVisible Boolean
-
Indicates whether to display labels for the track. If
true
, labels will appear as defined in the labelingInfo property.- Default Value:true
Example// Turns off track labels, but preserves labelingInfo const trackInfo = layer.trackInfo.clone(); trackInfo.labelsVisible = false; layer.trackInfo = trackInfo;
-
renderer
renderer RendererUnion |null |undefinedautocast
-
The renderer used to style the track part. Depending on the renderer type, features may be visualized with the same symbol or with varying symbols based on the values of the provided fields.
Examplelayer.trackInfo = { previousObservations: { renderer: { type: "simple", // autocasts as new SimpleRenderer() symbol: { type: "simple-marker", // autocasts as new SimpleFillSymbol() outline: { // autocasts as new SimpleLineSymbol() width: 0.5, color: "white" } }, visualVariables: [{ type: "color", field: "speed", stops: [ { value: 5, color: "red" }, { value: 45, color: "green" } ] }] } } };
-
visible
visible Boolean
-
Indicates whether the renderer of the track part is visible.
- Default Value:true
Example// Hides the renderer trackPartInfo.visible = false;
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. | TrackPartInfo | |
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TrackPartInfo | ||
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. | TrackPartInfo |
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.