arcgis-maps-kotlin/com.arcgismaps.realtime/ArcGISStreamServiceFilter

ArcGISStreamServiceFilter

Limits which dynamic entities are returned from an ArcGIS stream service. Set ArcGISStreamService.filter to an object of this type to apply a server-side filter on observations streamed from an ArcGIS stream service. Spatial or attribute filters (or both) are supported.

Using this server-side filter is useful for limiting how much data is streamed from an ArcGISStreamService and handled in the client application, which can help with application performance and memory efficiency.

Since

200.1.0

Constructors

ArcGISStreamServiceFilter

fun ArcGISStreamServiceFilter()

Creates an empty ArcGISStreamServiceFilter object.

Properties

geometry

var geometry: Geometry?

The geometry that is used to filter results. Dynamic entity observations that intersect this geometry are included in the stream. Those that are outside are excluded.

outFields

val outFields: MutableList<String>

A collection of field names that identify the observation values the server should return. This property instructs the service to return a subset of values when pushing observations to the client. Restricting the values returned will limit the amount of memory required to store individual observations and therefore reduce the memory footprint of the application.

outSpatialReference

var outSpatialReference: SpatialReference?

The spatial reference that dynamic entities are returned in. Use this property to instruct the service to provide observation geometries in the given spatial reference.

whereClause

var whereClause: String

A SQL expression that defines the dynamic entities to return. Use this property to filter dynamic entities by attribute value. Setting this property forces the server to filter observations using the given expression before adding them to the stream.