Dynamic
A Layer that displays dynamic entity observations from real-time services. A dynamic entity layer consumes com.arcgismaps.realtime.DynamicEntityObservation objects streamed from a com.arcgismaps.realtime.DynamicEntityDataSource. A com.arcgismaps.realtime.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:
DynamicEntityLayer.renderer: the main renderer property inherited from Layer is used to control the display of the latest observation in a track. All renderer types are supported.
TrackDisplayProperties.previousObservationRenderer: used to control the display of previous observations in a track. All renderer types are supported.
TrackDisplayProperties.trackLineRenderer: used to control the display of the track line between observations. All renderer types are supported; however, the track line attributes collection includes only the entity ID attribute that uniquely identifies the track. This attribute can be used to highlight a specific track using one of the attribute-based renderers.
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 com.arcgismaps.mapping.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 com.arcgismaps.realtime.DynamicEntityObservation objects. Use the com.arcgismaps.realtime.DynamicEntityObservation.getDynamicEntity method to retrieve the com.arcgismaps.realtime.DynamicEntity that the identified observation is associated with.
Since
200.1.0
Constructors
Creates a new dynamic entity layer from a com.arcgismaps.realtime.DynamicEntityDataSource.
Creates a new dynamic entity layer object from a stream service portal item. The item's type must be com.arcgismaps.portal.PortalItemType.Feed or com.arcgismaps.portal.PortalItemType.StreamService.
Properties
The dynamic entity data source.
The collection of com.arcgismaps.mapping.labeling.LabelDefinition objects for this layer. Dynamic entity layer supports labeling only on the latest observation of a track.
True if labels should be displayed, false otherwise. Dynamic entity layer supports labeling only on the latest observation of a track.
The com.arcgismaps.mapping.symbology.Renderer used to display the latest observation of dynamic entities.
The scene properties for the dynamic entity layer.
All selected dynamic entities.
All selected dynamic entity observations.
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
The attribution text for the layer.
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.
The description for the layer.
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 its com.arcgismaps.data.FeatureTable.extent.
The unique identifying string for the layer, as 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 com.arcgismaps.geotriggers.FeatureFenceParameters or a com.arcgismaps.mapping.floor.FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
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.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
A SharedFlow that emits when the visibility of the layer changes.
Functions
Clears all selected dynamic entities and observations. Use this method to clear the list of selected com.arcgismaps.realtime.DynamicEntity and com.arcgismaps.realtime.DynamicEntityObservation objects and clear the visible selection halos from the map or scene view.
Clones the DynamicEntityLayer.
Selects the specified dynamic entities. Selecting a com.arcgismaps.realtime.DynamicEntity does the following:
Selects the given dynamic entity and adds it to the current list of selected dynamic entities. Selecting a com.arcgismaps.realtime.DynamicEntity does the following:
Selects the given dynamic entity observation and adds it to the current list of selected observations. Selecting a com.arcgismaps.realtime.DynamicEntityObservation does the following:
Selects the given dynamic entity observations and adds them to the current list of selected observations. Selecting a com.arcgismaps.realtime.DynamicEntityObservation does the following:
Unselects the specified dynamic entities and removes them from the current list of selected dynamic entities.
Unselects the given dynamic entity and removes it from the current list of selected dynamic entities.
Unselects the given dynamic entity observation and removes it from the current list of selected observations.
Unselects the given dynamic entity observations and removes them from the current list of selected observations.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
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.