ArcGISStreamService QML Type
A DynamicEntityDataSource that receives a stream of observations from an ArcGIS stream service. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 200.1 |
Inherits: |
- List of all members, including inherited members
- ArcGISStreamService is part of QML Type List.
Properties
- filter : ArcGISStreamServiceFilter
- serviceInfo : ArcGISStreamServiceInfo
- url : url
Signals
Detailed Description
Currently, this is the only concrete class deriving from DynamicEntityDataSource.
Members of this class allow an application to:
- connect to and receive observations from an ArcGIS stream service
- access metadata about the ArcGIS stream service
- set a server-side filter on the service to limit the number and type of observations sent
In the current release, only stream services that send point geometries are supported.
To learn more about ArcGIS stream services see: ArcGIS Server - Stream Services in the ArcGIS Enterprise documentation.
Property Documentation
[default] filter : ArcGISStreamServiceFilter |
Defines which observations are returned from the service.
Use this property to define a filter that informs the server which observations to send on the stream. The filter may include spatial or attribute criteria (or both). Using this server-side filter is useful for limiting how much data must be handled in the client application, which can help with application performance and memory footprint.
This property is used when the data source connection is initiated; therefore, the filter cannot be changed once the data source is loaded.
The default value is null
, meaning no filter is applied.
[read-only] serviceInfo : ArcGISStreamServiceInfo |
Metadata that describes the ArcGIS stream service (read-only).
This property is null
by default and is populated when the data source loads.
Once the data source is loaded, you can use this metadata to find things like:
- Fields: Field definitions for data in the stream
- Track ID field: The field that contains a unique ID for each track in a track-aware service
- Archive service URL: A service that contains the latest observations for dynamic entities provided by this stream
url : url |
The URL of the stream service.
Signal Documentation
filterChanged() |
Emitted when the filter property changes.
Note: The corresponding handler is onFilterChanged
.
serviceInfoChanged() |
Emitted when the serviceInfo property changes.
Note: The corresponding handler is onServiceInfoChanged
.
urlChanged() |
Emitted when the url property changes.
Note: The corresponding handler is onUrlChanged
.