Display data from an ArcGIS stream service using a dynamic entity layer.
Use case
A stream service is a type of service provided by ArcGIS Velocity and GeoEvent Server that allows clients to receive a stream of data observations via a web socket. ArcGIS Maps SDK for Kotlin allows you to connect to a stream service and manage the information as dynamic entities and display them in a dynamic entity layer. Displaying information from feeds such as a stream service is important in applications like dashboards where users need to visualize and track updates of real-world objects in real-time.
Use ArcGISStreamService
to manage the connection to the stream service and purge options to manage how much data is stored and maintained by the application. The dynamic entity layer will display the latest received observation, and you can set track display properties to determine how to display historical information for each dynamic entity. This includes the number of previous observations to show, whether to display track lines in-between previous observations, and setting renderers.
How to use the sample
Use the controls to connect to or disconnect from the stream service, modify display properties in the dynamic entity layer, and purge all observations from the application.
How it works
- Create an
ArcGIStreamService
using aUrl
. - Set a
DynamicEntityFilter
on the stream service to limit the amount of data coming from the server. - Set the
MaximumDuration
property of the stream servicePurgeOptions
to limit the amount of data managed by the application. - Create a
DynamicEntityLayer
using the stream service. - Update values in the layer's
TrackDisplayProperties
to customize the layer's appearance. - Add the
DynamicEntityLayer
to the map.
Relevant API
- ArcGISStreamService
- DynamicEntity
- DynamicEntityFilter
- DynamicEntityLayer
- DynamicEntityPurgeOptions
- TrackDisplayProperties
About the data
This sample uses a stream service that simulates live data coming from snowplows near Sandy, Utah. There are multiple vehicle types and multiple agencies operating the snowplows.
Additional information
This sample uses the GeoView-Compose Toolkit module to be able to implement a composable MapView. More information about dynamic entities can be found in the guide documentation.
Tags
data, dynamic, entity, geoview-compose, live, purge, real-time, service, stream, toolkit, track
Sample Code
/* Copyright 2023 Esri
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.esri.arcgismaps.sample.adddynamicentitylayer.components
import android.app.Application
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.lifecycle.AndroidViewModel
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.DynamicEntityLayer
import com.arcgismaps.realtime.ArcGISStreamService
import com.arcgismaps.realtime.ArcGISStreamServiceFilter
import com.esri.arcgismaps.sample.adddynamicentitylayer.R
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.launch
class MapViewModel(
application: Application,
private val sampleCoroutineScope: CoroutineScope,
) : AndroidViewModel(application) {
// set the state of the switches and slider
val trackLineCheckedState = mutableStateOf(false)
val prevObservationCheckedState = mutableStateOf(false)
val trackSliderValue = mutableFloatStateOf(5f)
// flag to show or dismiss the bottom sheet
val isBottomSheetVisible = mutableStateOf(false)
// create ArcGIS Stream Service
private val streamService =
ArcGISStreamService(application.getString(R.string.stream_service_url))
// create ArcGISStreamServiceFilter
private val streamServiceFilter = ArcGISStreamServiceFilter()
// layer displaying the dynamic entities on the map
private val dynamicEntityLayer: DynamicEntityLayer
// define ArcGIS map using Streets basemap
val map = ArcGISMap(BasemapStyle.ArcGISStreets).apply {
initialViewpoint = Viewpoint(40.559691, -111.869001, 150000.0)
}
/**
* set the data source for the dynamic entity layer.
*/
init {
// set condition on the ArcGISStreamServiceFilter to limit the amount of data coming from the server
streamServiceFilter.whereClause = "speed > 0"
streamService.apply {
filter = streamServiceFilter
// sets the maximum time (in seconds) an observation remains in the application.
purgeOptions.maximumDuration = 300.0
}
dynamicEntityLayer = DynamicEntityLayer(streamService)
// add the dynamic entity layer to the map's operational layers
map.operationalLayers.add(dynamicEntityLayer)
}
// disconnects the stream service
fun disconnectStreamService() {
sampleCoroutineScope.launch {
streamService.disconnect()
}
}
// connects the stream service
fun connectStreamService() {
sampleCoroutineScope.launch {
streamService.connect()
}
}
// to dismiss the bottom sheet
fun dismissBottomSheet() {
isBottomSheetVisible.value = false
}
// to manage bottomSheet visibility
fun showBottomSheet() {
isBottomSheetVisible.value = true
}
// to manage track lines visibility
fun trackLineVisibility(checkedValue: Boolean) {
trackLineCheckedState.value = checkedValue
dynamicEntityLayer.trackDisplayProperties.showTrackLine = trackLineCheckedState.value
}
// to manage previous observations visibility
fun prevObservationsVisibility(checkedValue: Boolean) {
prevObservationCheckedState.value = checkedValue
dynamicEntityLayer.trackDisplayProperties.showPreviousObservations =
prevObservationCheckedState.value
}
// to set the maximum number of observations displayed per track
fun setObservations(sliderValue: Float) {
trackSliderValue.floatValue = sliderValue
dynamicEntityLayer.trackDisplayProperties.maximumObservations =
trackSliderValue.floatValue.toInt()
}
// remove all dynamic entity observations from the in-memory data cache as well as from the map
fun purgeAllObservations() {
sampleCoroutineScope.launch {
streamService.purgeAll()
}
}
}