DynamicEntityDataSourcePurgeOptions QML Type

  • Esri.ArcGISRuntime
  • DynamicEntityDataSourcePurgeOptions
  • Purge options for a dynamic entity data source. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 200.1
    Inherits:

    Object

    Properties

    Signals

    Detailed Description

    Data received from a DynamicEntityDataSource is cached in memory on the client and can grow quickly depending on the number of dynamic entities and frequency of updates. Use this class and the DynamicEntityDataSource::purgeOptions property to control app storage in the local data cache.

    Properties on this object affect cached observations and should not be confused with similar options in TrackDisplayProperties which are applied on the DynamicEntityLayer and affect visibility of observations on a map or scene.

    By default, the maximum total number of observations stored is 100,000 with no limit to the number of observations per track and no observation age limit.

    Note: You cannot declare or create a component of this type in QML code.

    Property Documentation

    maximumDuration : double

    Returns the maximum time (in seconds) an observation remains in the application.

    Observations older than the specified maximum duration are removed from the local data cache.

    The default value is 0.0 seconds which means the maximum duration is disabled and duration is not used to purge observations from the local data cache. Setting maximum duration to anything else below 1.0 defaults to 1.0.


    maximumObservations : int

    The maximum number of observations cached by the application.

    Use this property to limit the total number of observations cached in the local data cache without regard to the track the observations belong to.

    The default value is 100,000. A value of 0 disables the maximum observations purge option.


    maximumObservationsPerTrack : int

    The maximum number of observations per track.

    Use this property to limit the number of observations cached in the local data cache per unique track ID.

    The default value is 0 which means the maximum observations per track purge option is disabled.


    Signal Documentation

    maximumDurationChanged()

    Emitted when the maximumDuration property changes.

    Note: The corresponding handler is onMaximumDurationChanged.


    maximumObservationsChanged()

    Emitted when the maximumObservations property changes.

    Note: The corresponding handler is onMaximumObservationsChanged.


    maximumObservationsPerTrackChanged()

    Emitted when the maximumObservationsPerTrack property changes.

    Note: The corresponding handler is onMaximumObservationsPerTrackChanged.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.