TrackPartInfo | References | ArcGIS Maps SDK for JavaScript

import TrackPartInfo from "@arcgis/core/layers/support/TrackPartInfo.js";

Inheritance:: TrackPartInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.32

beta

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

TrackInfo

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TrackPartInfoProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`labelingInfo`	`LabelClass[] \| null \| undefined`
`labelsVisible`	`boolean`
`renderer`	`RendererUnion \| null \| undefined`
`visible`	`boolean`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

labelingInfo

autocast Property

Type: LabelClass[] | null | undefined

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

Property

Type: 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

autocast Property

Type: RendererUnion | null | undefined

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.

Example

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

Property

Type: boolean

Indicates whether the renderer of the track part is visible.

Default value: true

Example

// Hides the renderer
trackPartInfo.visible = false;

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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	`any`	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

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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.