DynamicEntityLayer QML Type
A Layer that displays dynamic entity observations from real-time services. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 200.1 |
| Inherits: |
- List of all members, including inherited members
- DynamicEntityLayer is part of QML Type List.
Properties
- dataSource : DynamicEntityDataSource
- labelDefinitions : LabelDefinitionListModel
- labelsEnabled : bool
- popupDefinition : PopupDefinition
- popupEnabled : bool
- renderer : Renderer
- sceneProperties : LayerSceneProperties
- trackDisplayProperties : TrackDisplayProperties
Signals
- dataSourceChanged()
- labelDefinitionsChanged()
- labelsEnabledChanged()
- popupDefinitionChanged()
- popupEnabledChanged()
- rendererChanged()
- scenePropertiesChanged()
- trackDisplayPropertiesChanged()
Methods
- void clearSelection()
- void selectDynamicEntities(DynamicEntityListModel dynamicEntities)
- void selectDynamicEntity(DynamicEntity dynamicEntity)
- void selectDynamicEntityObservation(DynamicEntityObservation dynamicEntityObservation)
- void selectDynamicEntityObservations(list<DynamicEntityObservation> dynamicEntityObservations)
- list<DynamicEntity> selectedDynamicEntities()
- list<DynamicEntityObservation> selectedDynamicEntityObservations()
- void unselectDynamicEntities(DynamicEntityListModel dynamicEntities)
- void unselectDynamicEntity(DynamicEntity dynamicEntity)
- void unselectDynamicEntityObservation(DynamicEntityObservation dynamicEntityObservation)
- void unselectDynamicEntityObservations(list<DynamicEntityObservation> dynamicEntityObservations)
Detailed Description
A dynamic entity layer consumes DynamicEntityObservation objects streamed from a DynamicEntityDataSource. 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:
- 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. The track line renderer supports only SimpleRenderer (since the track line contains no attributes).
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::dynamicEntity method to retrieve the DynamicEntity that the identified observation is associated with.
See also PopupSource.
Property Documentation
[default] dataSource : DynamicEntityDataSource |
The dynamic entity data source.
[default] labelDefinitions : LabelDefinitionListModel |
The collection of LabelDefinition objects for this layer.
Dynamic entity layer supports labeling only on the latest observation of a track.
labelsEnabled : bool |
true if labels should be displayed, false otherwise.
Dynamic entity layer supports labeling only on the latest observation of a track.
popupDefinition : PopupDefinition |
See PopupSource.
popupEnabled : bool |
See PopupSource.
[default] renderer : Renderer |
The Renderer used to display the latest observation of dynamic entities.
[default] sceneProperties : LayerSceneProperties |
The scene properties for the dynamic entity layer.
[read-only] trackDisplayProperties : TrackDisplayProperties |
The track display properties (read-only).
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.
Signal Documentation
dataSourceChanged() |
Emitted when the dataSource property changes.
Note: The corresponding handler is onDataSourceChanged.
labelDefinitionsChanged() |
Emitted when the labelDefinitions property changes.
Note: The corresponding handler is onLabelDefinitionsChanged.
labelsEnabledChanged() |
Emitted when the labelsEnabled property changes.
Note: The corresponding handler is onLabelsEnabledChanged.
popupDefinitionChanged() |
Emitted when the popupDefinition property changes.
Note: The corresponding handler is onPopupDefinitionChanged.
popupEnabledChanged() |
Emitted when the popupEnabled property changes.
Note: The corresponding handler is onPopupEnabledChanged.
rendererChanged() |
Emitted when the renderer property changes.
Note: The corresponding handler is onRendererChanged.
scenePropertiesChanged() |
Emitted when the sceneProperties property changes.
Note: The corresponding handler is onScenePropertiesChanged.
trackDisplayPropertiesChanged() |
Emitted when the trackDisplayProperties property changes.
Note: The corresponding handler is onTrackDisplayPropertiesChanged.
Method Documentation
void clearSelection() |
Clears all selected dynamic entity 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.
void selectDynamicEntities(DynamicEntityListModel dynamicEntities) |
Selects the specified dynamic entities.
- dynamicEntities - The dynamic entities to select.
Selecting a DynamicEntity does the following:
- adds the dynamic entity to the current list of selected dynamic entities.
- adds a visual selection halo around the latest observation of the dynamic entity. The selection halo is always placed on the latest observation of the dynamic entity, so the selection halo moves as new observations are received for the dynamic entity.
void selectDynamicEntity(DynamicEntity dynamicEntity) |
Selects the given dynamic entity and adds it to the current list of selected dynamic entities.
- dynamicEntity - The dynamic entity to select.
Selecting a DynamicEntity does the following:
- adds the dynamic entity to the current list of selected dynamic entities.
- adds a visual selection halo around the latest observation of the dynamic entity. The selection halo is always placed on the latest observation of the dynamic entity, so the selection halo moves as new observations are received for the dynamic entity.
void selectDynamicEntityObservation(DynamicEntityObservation dynamicEntityObservation) |
Selects the given dynamic entity observation and adds it to the current list of selected observations.
- dynamicEntityObservation - The dynamic entity observation to select.
Selecting a DynamicEntityObservation does the following:
- adds the DynamicEntityObservation to the current list of selected dynamic entity observations.
- adds a visual selection halo around the static DynamicEntityObservation.
Use selectDynamicEntity(DynamicEntity) to achieve dynamic selection of the latest observation in a track.
void selectDynamicEntityObservations(list<DynamicEntityObservation> dynamicEntityObservations) |
Selects the given dynamic entity observations and adds them to the current list of selected observations.
- dynamicEntityObservations - The dynamic entity observations to select.
Selecting a DynamicEntityObservation does the following:
- adds the DynamicEntityObservation to the current list of selected dynamic entity observations.
- adds a visual selection halo around the static DynamicEntityObservation.
Use selectDynamicEntity(DynamicEntity) to achieve dynamic selection of the latest observation in a track.
list<DynamicEntity> selectedDynamicEntities() |
Gets all selected dynamic entities.
list<DynamicEntityObservation> selectedDynamicEntityObservations() |
Gets all selected dynamic entity observations.
void unselectDynamicEntities(DynamicEntityListModel dynamicEntities) |
Unselects the specified dynamic entities and removes them from the current list of selected dynamic entities.
- dynamicEntities - The dynamic entities to remove from the selection.
void unselectDynamicEntity(DynamicEntity dynamicEntity) |
Unselects the given dynamic entity and removes it from the current list of selected dynamic entities.
- dynamicEntity - The dynamic entity to be unselected.
void unselectDynamicEntityObservation(DynamicEntityObservation dynamicEntityObservation) |
Unselects the given dynamic entity observation and removes it from the current list of selected dynamic entity observations.
- dynamicEntityObservation - The dynamic entity observation to be unselected.
void unselectDynamicEntityObservations(list<DynamicEntityObservation> dynamicEntityObservations) |
Unselects the specified dynamic entity observations and removes them from the current list of selected dynamic entity observations.
- dynamicEntityObservations - The dynamic entity observations to remove from the selection.