import PurgeOptions from "@arcgis/core/layers/support/PurgeOptions.js";const PurgeOptions = await $arcgis.import("@arcgis/core/layers/support/PurgeOptions.js");- Inheritance:
- PurgeOptions→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Options for purging stale features from StreamLayer. The purge options controls how much data is removed from StreamLayerView and how often. Choosing the right purge rule for your stream layer is critical for maximizing functionality and performance. Cannot be changed after the layer has been loaded.
- See also
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
declaredClass readonly inherited | ||
| | ||
| |
age
Specifies the maximum age of a feature in minutes. It purges features whose start time specified in the TimeInfo.startField
of the feature is older than the age. If no new features coming in then the age of the application does not advance.
maxObservations
Controls the maximum number of observations to show within a track. If TimeInfo.trackIdField is not configured on the geoevent service, this property will have no effect. The default is 1.
- Default value
- 1
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.