Controls the display of tracks for a DynamicEntityLayer. More...
| Header: | #include <TrackDisplayProperties.h> |
| Since: | Esri::ArcGISRuntime 200.1 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~TrackDisplayProperties() override |
| bool | isShowPreviousObservations() const |
| bool | isShowTrackLine() const |
| double | maximumDuration() const |
| int | maximumObservations() const |
| Esri::ArcGISRuntime::Renderer * | previousObservationRenderer() const |
| void | setMaximumDuration(double maximumDuration) |
| void | setMaximumObservations(int maximumObservations) |
| void | setPreviousObservationRenderer(Esri::ArcGISRuntime::Renderer *previousObservationRenderer) |
| void | setShowPreviousObservations(bool showPreviousObservations) |
| void | setShowTrackLine(bool showTrackLine) |
| void | setTrackLineRenderer(Esri::ArcGISRuntime::Renderer *trackLineRenderer) |
| Esri::ArcGISRuntime::Renderer * | trackLineRenderer() const |
Detailed Description
Track display properties allow you to control the display of dynamic entity observations by setting a maximum number of observations to show, displaying a line that connects them (track line), and applying renderers to the previous observations and/or track line.
Relevant samples:
- Add custom dynamic entity data source: Create a custom dynamic entity data source and display it using a dynamic entity layer.
- Add dynamic entity layer: Display data from an ArcGIS stream service using a dynamic entity layer.
Member Function Documentation
[override virtual] TrackDisplayProperties::~TrackDisplayProperties ()
Destructor.
bool TrackDisplayProperties::isShowPreviousObservations () const
Returns a flag indicating whether to show previous observations.
This flag only affects previous observations, the latest observation of the track is always displayed.
bool TrackDisplayProperties::isShowTrackLine () const
Returns a flag indicating whether to show a line that connects observations with the same track ID.
double TrackDisplayProperties::maximumDuration () const
Returns the maximum time (in seconds) a previous observation displays in the track.
Previous observations older than the specified maximum duration are not displayed.
The default value is 0.0 which means the maximum duration is disabled. Setting maximum duration to anything below 1.0 defaults to 1.0.
See also setMaximumDuration().
int TrackDisplayProperties::maximumObservations () const
Returns the maximum number of observations displayed per track (this includes latest and previous observations).
The default value is 5.
See also setMaximumObservations().
Esri::ArcGISRuntime::Renderer *TrackDisplayProperties::previousObservationRenderer () const
Returns the Renderer to display the previous observations.
See also setPreviousObservationRenderer().
void TrackDisplayProperties::setMaximumDuration (double maximumDuration )
Sets the maximumDuration to maximumDuration.
See also maximumDuration.
void TrackDisplayProperties::setMaximumObservations (int maximumObservations )
Sets the maximumObservations to maximumObservations.
See also maximumObservations.
void TrackDisplayProperties::setPreviousObservationRenderer (Esri::ArcGISRuntime::Renderer *previousObservationRenderer )
Sets the previousObservationRenderer to previousObservationRenderer.
See also previousObservationRenderer.
void TrackDisplayProperties::setShowPreviousObservations (bool showPreviousObservations )
Sets the showPreviousObservations to showPreviousObservations.
See also isShowPreviousObservations.
void TrackDisplayProperties::setShowTrackLine (bool showTrackLine )
Sets the showTrackLine to showTrackLine.
See also isShowTrackLine.
void TrackDisplayProperties::setTrackLineRenderer (Esri::ArcGISRuntime::Renderer *trackLineRenderer )
Sets the trackLineRenderer to trackLineRenderer.
See also trackLineRenderer.
Esri::ArcGISRuntime::Renderer *TrackDisplayProperties::trackLineRenderer () const
Returns the Renderer to display the track lines that connect 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.
See also setTrackLineRenderer().