Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for .NET

Access load status

This code sample is available for these platforms:
View Sample on GitHub

Determine the map's load status which can be: NotLoaded, FailedToLoad, Loading, Loaded.

screenshot

Use case

Knowing the map's load state may be required before subsequent actions can be executed.

How to use the sample

The load status of the map will be displayed as the sample loads.

How it works

  1. Create a Map and add it to a MapView.
  2. Use the Map.LoadStatusChanged event to listen for changes in the map's load status.

The LoadStatus is Loaded when any of the following criteria are met:

  • The map has a valid spatial reference.
  • The map has an an initial viewpoint.
  • One of the map's predefined layers has been created.

Relevant API

  • Map
  • ILoadable
  • MapView

Tags

LoadStatus, Loadable pattern, Map

Sample Code

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"             
             xmlns:esriUI="clr-namespace:Esri.ArcGISRuntime.Xamarin.Forms;assembly=Esri.ArcGISRuntime.Xamarin.Forms"
             xmlns:mapping="clr-namespace:Esri.ArcGISRuntime.Mapping;assembly=Esri.ArcGISRuntime" 
             x:Class="ArcGISRuntime.Samples.AccessLoadStatus.AccessLoadStatus">
  <Grid>
    <Grid.RowDefinitions>
      <RowDefinition Height="auto" />
      <RowDefinition Height="*" />
    </Grid.RowDefinitions>
    <StackLayout Orientation="Horizontal">
      <Label x:Name="loadStatusLabel" Text="Map's load status : "/>
    </StackLayout>
    <esriUI:MapView x:Name="myMapView"  Grid.Row="1"/>
  </Grid>
</ContentPage>
// Copyright 2016 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 Esri.ArcGISRuntime;
using Esri.ArcGISRuntime.Mapping;
using Xamarin.Forms;

namespace ArcGISRuntime.Samples.AccessLoadStatus
{
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        name: "Access load status",
        category: "Map",
        description: "Determine the map's load status which can be: `NotLoaded`, `FailedToLoad`, `Loading`, `Loaded`.",
        instructions: "The load status of the map will be displayed as the sample loads.",
        tags: new[] { "LoadStatus", "Loadable pattern", "Map" })]
    public partial class AccessLoadStatus : ContentPage
    {
        public AccessLoadStatus()
        {
            InitializeComponent ();

            // Create the UI, setup the control references and execute initialization 
            Initialize();
        }

        private void Initialize()
        {
            // Create new Map with basemap
            Map myMap = new Map(Basemap.CreateImagery());

            // Register to handle loading status changes
            myMap.LoadStatusChanged += OnMapsLoadStatusChanged;

            // Provide used Map to the MapView
            myMapView.Map = myMap;
        }

        private void OnMapsLoadStatusChanged(object sender, LoadStatusEventArgs e)
        {
            // Make sure that the UI changes are done in the UI thread
            Device.BeginInvokeOnMainThread(() =>
            {
                // Update the load status information
                loadStatusLabel.Text = $"Map's load status : {e.Status}";
            });
        }
    }
}