DynamicEntityLayer

A Layer that displays dynamic entity observations from real-time services. A dynamic entity layer consumes DynamicEntityObservation objects streamed from a DynamicEntityDataSource. A DynamicEntityDataSource must be passed to the constructor of the layer. The layer manages the display of observations as they are added to or removed from the data source's local cache.

A dynamic entity layer's TrackDisplayProperties allow you to control the display of previous observations by setting a maximum number of observations to show, displaying a line that connects them (track line), and applying renderers to the observations and/or track line.

As with other layers in the ArcGIS Maps SDK, display properties are managed with renderers. In the dynamic entity layer, three renderers are used to control display of observations:

Labels in a dynamic entity layer are controlled through the inherited Layer labeling API. Labels only appear on the latest observation in a track and are not placed on previous observations.

The dynamic entity layer has methods for selecting or unselecting dynamic entities and observations in the display. When selecting a dynamic entity, the selection moves with the entity (the selection halo moves to the latest observation in the track) as new observations are received from the stream. Since observations are static, selected observations appear like any static GeoElement on the display.

Dynamic entity layer also supports identify behavior in a map view or scene view. Be aware that the identify results from this layer consist entirely of DynamicEntityObservation objects. Use the DynamicEntityObservation.getDynamicEntity() method to retrieve the DynamicEntity that the identified observation is associated with.

Since

200.1.0

Constructors

Link copied to clipboard

Creates a new dynamic entity layer from a DynamicEntityDataSource.

Properties

Link copied to clipboard

The dynamic entity data source.

Link copied to clipboard

The collection of LabelDefinition objects for this layer. Dynamic entity layer supports labeling only on the latest observation of a track.

Link copied to clipboard

True if labels should be displayed, false otherwise. Dynamic entity layer supports labeling only on the latest observation of a track.

Link copied to clipboard

The Renderer used to display the latest observation of dynamic entities.

Link copied to clipboard

The scene properties for the dynamic entity layer.

Link copied to clipboard

All selected dynamic entities.

Link copied to clipboard

All selected dynamic entity observations.

Link copied to clipboard

The track display properties. TrackDisplayProperties allow you to control the display of previous observations in a track by setting a maximum number of observations to show, displaying a line that connects them (track line), and applying renderers to the observations and/or track line.

Inherited properties

Link copied to clipboard

The attribution text for the layer.

Link copied to clipboard
open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

Link copied to clipboard

The description for the layer. The description of the layer.

Link copied to clipboard

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from the tables extent.

Link copied to clipboard
var id: String

The unique identifying string for the layer, for example specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

Link copied to clipboard

Whether the layer supports identify. If the layer is not loaded it may return false if identify support is determined by metadata that is not yet available.

Link copied to clipboard
open override var isPopupEnabled: Boolean

A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.

Link copied to clipboard
open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

Link copied to clipboard
val item: Item?

The item the layer has been created from.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

The maximum scale for the layer. This controls the maximum scale level the layer can zoom to. All of the connected map views will be updated.

Link copied to clipboard

The minimum scale for the layer. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

Link copied to clipboard
open override var name: String

The name of this layer.

Link copied to clipboard

The opacity for the layer. All of the connected map views will be updated.

Link copied to clipboard
open override var popupDefinition: PopupDefinition?

The pop-up definition. The PopupDefinition associated with the popup source. A null if an error occurs or if the popup source is not associated with a pop-up definition.

Link copied to clipboard
open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

Link copied to clipboard

The spatial reference of the layer.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Link copied to clipboard
val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

Link copied to clipboard

Clears all selected dynamic entities and observations. Use this method to clear the list of selected DynamicEntity and DynamicEntityObservation objects and clear the visible selection halos from the map or scene view.

Link copied to clipboard
open override fun clone(): DynamicEntityLayer

Clones the DynamicEntityLayer.

Link copied to clipboard

Selects the specified dynamic entities. Selecting a DynamicEntity does the following:

Link copied to clipboard

Selects the given dynamic entity and adds it to the current list of selected dynamic entities. Selecting a DynamicEntity does the following:

Link copied to clipboard

Selects the given dynamic entity observation and adds it to the current list of selected observations. Selecting a DynamicEntityObservation does the following:

Link copied to clipboard

Selects the given dynamic entity observations and adds them to the current list of selected observations. Selecting a DynamicEntityObservation does the following:

Link copied to clipboard

Unselects the specified dynamic entities and removes them from the current list of selected dynamic entities.

Link copied to clipboard

Unselects the given dynamic entity and removes it from the current list of selected dynamic entities.

Link copied to clipboard

Unselects the given dynamic entity observation and removes it from the current list of selected observations.

Link copied to clipboard

Unselects the given dynamic entity observations and removes them from the current list of selected observations.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.