Display and browse through building floors from a floor-aware web map.
Use case
Having map data to aid indoor navigation in buildings with multiple floors such as airports, museums, or offices can be incredibly useful. For example, you may wish to browse through all available floor maps for an office in order to find the location of an upcoming meeting in advance.
How to use the sample
Use the combo box to browse different floor levels in the facility. Only the selected floor will be displayed.
How it works
- Create a
PortalItem
using the identifier of a floor-aware web map. - Create a map using the portal item.
- Create a map view and assign the map to it.
- Wait for the map to load and retrieve the map's
FloorManager
property. - Wait for the floor manager to load and retrieve the floor-aware data.
- Set all floors to not visible.
- Select the ground floor by default. The ground floor is the entry in a facility's level collection that has
VerticalOrder
of zero. Vertical order can be negative for underground floors. - Set the selected level's
IsVisible
property to true. - When the selected floor changes, set the old selection's
IsVisible
property to false, and the new selection'sIsVisible
property to true.
- Note: Manually set the default floor level to the first floor.
Relevant API
- FloorAware
- FloorLevel
- FloorManager
- Map
- PortalItem
About the data
This sample uses a floor-aware web map that displays the floors of Building L on the Esri Redlands campus.
Additional information
The FloorManager
API also supports browsing different sites and facilities in addition to building floors.
Tags
building, facility, floor, floor-aware, floors, ground floor, indoor, level, site, story
Sample Code
// Copyright 2022 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.Mapping;
using Esri.ArcGISRuntime.Mapping.Floor;
using Microsoft.UI.Xaml.Controls;
using System;
using System.Threading.Tasks;
namespace ArcGIS.WinUI.Samples.BrowseBuildingFloors
{
[ArcGIS.Samples.Shared.Attributes.Sample(
name: "Browse building floors",
category: "Map",
description: "Display and browse through building floors from a floor-aware web map.",
instructions: "Use the combo box to browse different floor levels in the facility. Only the selected floor will be displayed.",
tags: new[] { "building", "facility", "floor", "floor-aware", "floors", "ground floor", "indoor", "level", "site", "story" })]
public partial class BrowseBuildingFloors
{
public BrowseBuildingFloors()
{
InitializeComponent();
_ = Initialize();
}
private async Task Initialize()
{
try
{
// Gets the floor data from ArcGIS Online and creates a map with it.
Map map = new Map(new Uri("https://ess.maps.arcgis.com/home/item.html?id=f133a698536f44c8884ad81f80b6cfc7"));
MyMapView.Map = map;
// Map needs to be loaded in order for floormanager to be used.
await MyMapView.Map.LoadAsync();
// Checks to see if the layer is floor aware.
if (MyMapView.Map.FloorDefinition == null)
{
await new MessageDialog2("The layer is not floor aware.", "Error").ShowAsync();
return;
}
await MyMapView.Map.FloorManager.LoadAsync();
FloorFacility selectedFacility = MyMapView.Map.FloorManager.Facilities[0];
FloorChooser.ItemsSource = selectedFacility.Levels;
}
catch (Exception ex)
{
await new MessageDialog2(ex.Message, "Error").ShowAsync();
}
}
private void OnFloorChooserSelectionChanged(object sender, SelectionChangedEventArgs e)
{
// Set all existing floors visibility to false.
foreach (FloorLevel level in MyMapView.Map.FloorManager.Facilities[0].Levels)
{
level.IsVisible = false;
}
// Set the selected floor to visible.
FloorLevel selectedFloor = (FloorLevel)FloorChooser.SelectedItem;
selectedFloor.IsVisible = true;
MyMapView.SetViewpoint(new Viewpoint(selectedFloor.Geometry));
}
}
}