Display a map

Learn how to create and display a map with a basemap layer.

A map contains layers of geographic data. A map contains a basemap layer and, optionally, one or more data layers. You can display a specific area of a map by using a map view and setting the location and zoom level.

In this tutorial, you create and display a map of the Santa Monica Mountains in California using the topographic basemap layer.

The map and code will be used as the starting point for other 2D tutorials.

Prerequisites

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Your system meets the system requirements.
You need an IDE for Flutter - we recommend VS Code.

Set up authentication

To access the secure ArcGIS location services used in this tutorial, you must implement API key authentication using an ArcGIS Location Platform or an ArcGIS Online account.

Create a new API key access token with privileges to access the secure resources used in this tutorial.

Complete the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
Copy and paste the API key access token into a safe location. It will be used in a later step.

Develop or download

You have two options for completing this tutorial:

Option 1: Develop the code or
Option 2: Download the completed solution

Option 1: Develop the code

Create a new Flutter app

Open VS Code, then select Open Folder... in the welcome tab. Choose your preferred project location.
Go to View > Terminal.
In the terminal window, use the following command to create a new Flutter app called display_a_map. Set your required target platform(s) and an org name, com.example.app.
Use dark colors for code blocksCopy
```
1
flutter create -e display_a_map --platforms ios,android --org com.example.app
```

Add ArcGIS Maps SDK for Flutter

Add a dependency to the arcgis_maps package.

In VS Code's terminal, change the directory to your new project:
Use dark colors for code blocksCopy
```
1
  cd display_a_map
```
Run:
Use dark colors for code blocksCopy
```
1
dart pub add arcgis_maps
```
Run:
Use dark colors for code blocksCopy
```
1
flutter pub upgrade
```
Lastly, run:
Use dark colors for code blocksCopy
```
1
dart run arcgis_maps install
```

Platform specific configuration

Update the minimum requirements by editing android/app/build.gradle.kts file in your project:

build.gradle.kts
Use dark colors for code blocks
7
7
7
7
7
7
7
8
9
10
11
12
13
14
14
14
14
14
14
14
14
14
14
15
16
17
18
19
20
21
22
23
24
25
26
26
26
26
26
26
26
26
26
26
26
26
26
26
Change lineChange lineandroid {
    namespace = "com.example.app.display_a_map"
    compileSdk = flutter.compileSdkVersion
    ndkVersion = "27.0.12077973"

    // ...

    defaultConfig {
        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
        applicationId = "com.example.app.display_a_map"
        // You can update the following values to match your application needs.
        // For more information, see: https://flutter.dev/to/review-gradle-config.
        minSdk = 26
        targetSdk = flutter.targetSdkVersion
        versionCode = flutter.versionCode
        versionName = flutter.versionName
    }

    // ...

Update the Kotlin version by editing android/settings.gradle.kts file in your project:

settings.gradle.kts
Use dark colors for code blocks
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
18
19
20
21
22
23
24
25
26
27
27
27
Change line// ...

plugins {
    id("dev.flutter.flutter-plugin-loader") version "1.0.0"
    id("com.android.application") version "8.7.0" apply false
    id("org.jetbrains.kotlin.android") version "1.9.0" apply false
}

// ...

Add a permission to android/app/src/main/AndroidManifest.xml to access online resources:

AndroidManifest.xml
Use dark colors for code blocks
2
3
4
5
6
7
8
9
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
10
Add line.
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET" />
    <application
        android:label="display_a_map"
        android:name="${applicationName}"
        android:icon="@mipmap/ic_launcher">

        <!-- ... -->

Set iOS 16.0 minimum by editing the ios/Podfile file. Uncomment the line and update the version number.

Podfile
Use dark colors for code blocks
2
3
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
4
Change line
# Uncomment this line to define a global platform for your project
platform :ios, '16.0'

Add the Runtimecore and arcgis_maps_ffi pods to the Runner target section.

Podfile
Use dark colors for code blocks
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
30
31
32
33
34
35
36
37
38
39
40
41
41
41
41
41
41
41
Change lineChange linetarget 'Runner' do
  use_frameworks!

  pod 'Runtimecore', :podspec => '../arcgis_maps_core/ios/Runtimecore.podspec'
  pod 'arcgis_maps_ffi', :podspec => '../arcgis_maps_core/ios/arcgis_maps_ffi.podspec'

  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
  target 'RunnerTests' do
    inherit! :search_paths
  end
end

Use pod update to configure Pods.
Use dark colors for code blocksCopy
```
1
  cd ios && pod update && cd ..
```

Set developer credentials

To allow your app users to access ArcGIS location services, use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

In VS Code, open lib/main.dart.

Import the arcgis_maps package.

main.dart
Use dark colors for code blocks
import 'package:flutter/material.dart';

import 'package:arcgis_maps/arcgis_maps.dart';

In the main() function, set the ArcGISEnvironment.apiKey value to your access token.

main.dart
Use dark colors for code blocks
void main() {

  ArcGISEnvironment.apiKey = 'YOUR_ACCESS_TOKEN';

  runApp(const MainApp());
}

Best Practice: The access token is stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.

Instantiate MaterialApp inside runApp() and set the named argument, home, to an instance of MainApp.

main.dart
Use dark colors for code blocks
void main() {

  ArcGISEnvironment.apiKey = 'YOUR_ACCESS_TOKEN';

  runApp(

    const MaterialApp(home: MainApp())

  );
}

Add a map

Create a map that contains a topographic basemap layer. The map will be centered on the Santa Monica Mountains in California.

Refactor the template MainApp class definition to extend StatefulWidget. Hover your mouse over the StatelessWidget keyword, right-click, select Refactor..., and chose Convert to StatefulWidget to refactor your code.

When working with the ArcGIS Maps SDK for Flutter, it is very common to require updates to application state, such as making updates to the UI in response to data changes. By implementing a stateful widget, your app is ready for this. It is also possible to simply display a map using a stateless widget implementation, see the Display map sample.

main.dart
Use dark colors for code blocks
class MainApp extends StatefulWidget {

  const MainApp({super.key});

  @override
  State<MainApp> createState() => _MainAppState();

}

class _MainAppState extends State<MainApp> {
  @override
  Widget build(BuildContext context) {

    return const MaterialApp(
      home: Scaffold(body: Center(child: Text('Hello World!'))),
    );

  }
}

Remove the MaterialApp widget that is returned within the build method of class _MainAppState. This code was generated by the Flutter create template and will be replaced with code to return a widget that contains a map next.

main.dart
Use dark colors for code blocks
class _MainAppState extends State<MainApp> {
  @override
  Widget build(BuildContext context) {

    return const MaterialApp(
      home: Scaffold(body: Center(child: Text('Hello World!'))),
    );

  }
}

Inside _MainAppState class define a final class member variable, _mapViewController, and initialize it with ArcGISMapViewController by calling the createController() on the ArcGISMapView class.

The ArcGIS map view controller is a user interface control that displays two-dimensional (2D) geographic content defined by an ArcGISMap.

main.dart
Use dark colors for code blocks
class _MainAppState extends State<MainApp> {

  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {

  }

}

Within the build method, add an ArcGISMapView widget to the widget tree consisting of Scaffold, Column, and Expanded. Set the named argument, controllerProvider, to the class member variable _mapViewController and the onMapViewReady argument to a new method with the same name as the argument that you will define next.

The Scaffold widget provides a basic material design visual layout structure, while the Column widget displays its children in a vertical array. The ArcGISMapView widget can only be used within a widget that has a bounded size. Using it with unbounded size will cause the application to throw an exception. For example, to use an ArcGISMapView within a Column widget, which would give it unbounded size, would produce such an exception. Instead, you could wrap the ArcGISMapView in an Expanded widget to provide it proper bounds as illustrated in this step of the tutorial.
main.dart
Use dark colors for code blocks
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class _MainAppState extends State<MainApp> {

  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          Expanded(
            child: ArcGISMapView(
              controllerProvider: () => _mapViewController,
              onMapViewReady: onMapViewReady,
            ),
          ),
        ],
      ),
    );

  }

}
```

Within _MainAppState, define a new method: onMapViewReady() that does not return anything.

main.dart
Use dark colors for code blocks
class _MainAppState extends State<MainApp> {

  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          Expanded(
            child: ArcGISMapView(
              controllerProvider: () => _mapViewController,
              onMapViewReady: onMapViewReady,
            ),
          ),
        ],
      ),
    );

  }

  void onMapViewReady() {

  }

}

Within the new method define a final variable, map, and initialize it to an ArcGISMap with the ArcGIS Topographic basemap style.

main.dart
Use dark colors for code blocks
class _MainAppState extends State<MainApp> {

  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          Expanded(
            child: ArcGISMapView(
              controllerProvider: () => _mapViewController,
              onMapViewReady: onMapViewReady,
            ),
          ),
        ],
      ),
    );

  }

  void onMapViewReady() {

    final map = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic);

  }

}

Set the ArcGIS map view controller's arcGISMap property to the map. In addition, call setViewpoint() to zoom to the Santa Monica Mountains in California.

main.dart
Use dark colors for code blocks
class _MainAppState extends State<MainApp> {

  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          Expanded(
            child: ArcGISMapView(
              controllerProvider: () => _mapViewController,
              onMapViewReady: onMapViewReady,
            ),
          ),
        ],
      ),
    );

  }

  void onMapViewReady() {

    final map = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic);

    _mapViewController.arcGISMap = map;
    _mapViewController.setViewpoint(
      Viewpoint.withLatLongScale(
        latitude: 34.02700,
        longitude: -118.80500,
        scale: 72000,
      ),
    );

  }

}

Run the app

Make sure you have an Android emulator, iOS simulator or physical device configured and running.
In VS Code, select Run > Run Without Debugging.

You will see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pinch, drag, and double-tap the map view to explore the map.

Alternatively, you can download the tutorial solution, as follows.

Option 2: Download the solution

Click the Download solution link under Solution and unzip the file to a location on your machine.
Open the project in VS code.

Since the downloaded solution does not contain authentication credentials, you must add the developer credentials that you created in the Set up authentication section.

Set developer credentials in the solution

To allow your app users to access ArcGIS location services, use the developer credentials that you created in the Set up authentication step to authenticate requests for resources.

In VS Code, open lib/main.dart.

In the main() function, set the ArcGISEnvironment.apiKey value to your access token.

main.dart
Use dark colors for code blocks
void main() {

  ArcGISEnvironment.apiKey = 'YOUR_ACCESS_TOKEN';

  runApp(const MainApp());
}

Best Practice: The access token is stored directly in the code as a convenience for this tutorial. Do not store credentials directly in source code in a production environment.

Run the application

Follow these steps to run the application.

In VS Code's terminal, run:
Use dark colors for code blocksCopy
```
1
flutter pub upgrade
```
Run:
Use dark colors for code blocksCopy
```
1
dart run arcgis_maps install
```
Make sure you have an Android emulator, iOS simulator or physical device configured and running.
In VS Code, select Run > Run Without Debugging.

You will see a map with the topographic basemap layer centered on the Santa Monica Mountains in California. Pinch, drag, and double-tap the map view to explore the map.