Get the draw status of your map view or scene view to know when all layers in the map or scene have finished drawing.
Use case
You may want to display a loading indicator while layers are loading, which could then be removed on DrawStatus.Completed
.
How to use the sample
Pan and zoom around the map. Observe how the status changes from a loading animation to solid, indicating that drawing has completed.
How it works
- Create a
MapView
and subscribe to theDrawStatusChanged
event. - Inspect the draw status property in the event handler to determine draw status.
Relevant API
- Map
- DrawStatus
- DrawStatusChangedEvent
- DrawStatusChangedListener
- MapView
Tags
draw, loading, map, render
Sample Code
DisplayDrawingStatus.cs
// Copyright 2021 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.
using Android.App;
using Android.OS;
using Android.Widget;
using Esri.ArcGISRuntime.Data;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.UI;
using Esri.ArcGISRuntime.UI.Controls;
using System;
namespace ArcGISRuntime.Samples.DisplayDrawingStatus
{
[Activity(ConfigurationChanges = Android.Content.PM.ConfigChanges.Orientation | Android.Content.PM.ConfigChanges.ScreenSize)]
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Display draw status",
category: "MapView",
description: "Get the draw status of your map view or scene view to know when all layers in the map or scene have finished drawing.",
instructions: "Pan and zoom around the map. Observe how the status changes from a loading animation to solid, indicating that drawing has completed.",
tags: new[] { "draw", "loading", "map", "render" })]
public class DisplayDrawingStatus : Activity
{
// Hold a reference to the map view
private MapView _myMapView;
// Waiting popup
private ProgressBar _progressBar;
// Status label
private TextView _statusLabel;
protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
Title = "Display drawing status";
// Create the UI, setup the control references and execute initialization
CreateLayout();
Initialize();
}
private void Initialize()
{
// Hook up the DrawStatusChanged event
_myMapView.DrawStatusChanged += OnDrawStatusChanged;
// Create new Map with basemap
Map myMap = new Map(BasemapStyle.ArcGISTopographic);
// Create uri to the used feature service
Uri serviceUri = new Uri(
"https://sampleserver6.arcgisonline.com/arcgis/rest/services/DamageAssessment/FeatureServer/0");
// Initialize a new feature layer
ServiceFeatureTable myFeatureTable = new ServiceFeatureTable(serviceUri);
FeatureLayer myFeatureLayer = new FeatureLayer(myFeatureTable);
// Add the feature layer to the Map
myMap.OperationalLayers.Add(myFeatureLayer);
// Provide used Map to the MapView
_myMapView.Map = myMap;
// Zoom to the United States.
_myMapView.SetViewpointCenterAsync(new MapPoint(-10800000, 4500000, SpatialReferences.WebMercator), 3e7);
}
private void OnDrawStatusChanged(object sender, DrawStatusChangedEventArgs e)
{
// Make sure that the UI changes are done in the UI thread
RunOnUiThread(() =>
{
// Show the activity indicator if the map is drawing
if (e.Status == DrawStatus.InProgress)
{
_progressBar.Visibility = Android.Views.ViewStates.Visible;
_statusLabel.Text = "Drawing status: In progress";
}
else
{
_progressBar.Visibility = Android.Views.ViewStates.Invisible;
_statusLabel.Text = "Drawing status: Complete";
}
});
}
private void CreateLayout()
{
// Create a new vertical layout for the app
LinearLayout layout = new LinearLayout(this) { Orientation = Orientation.Vertical };
_statusLabel = new TextView(this);
_statusLabel.Text = "Drawing status: unknown";
_progressBar = new ProgressBar(this) { Indeterminate = true };
_myMapView = new MapView(this);
// Add the views to the layout
layout.AddView(_progressBar);
layout.AddView(_statusLabel);
layout.AddView(_myMapView);
// Show the layout in the app
SetContentView(layout);
}
}
}