Display a map | ArcGIS Maps SDK for Flutter

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 or user authentication using an ArcGIS Location Platform or an ArcGIS Online account.

You can implement API key authentication or user authentication in this tutorial. Compare the differences below:

API key authentication

Users are not required to sign in.
Requires creating an API key credential with the correct privileges.
API keys are long-lived access tokens.
Service usage is billed to the API key owner/developer.
Simplest authentication method to implement.
Recommended approach for new ArcGIS developers.

Learn more in API key authentication.

User authentication

Users are required to sign in with an ArcGIS account.
User accounts must have privilege to access the ArcGIS services used in application.
Requires creating OAuth credentials.
Application uses a redirect URL and client ID.
Service usage is billed to the organization of the user signed into the application.

Learn more in User authentication.

To complete this tutorial, click on the tab in the switcher below for your authentication type of choice, either API key authentication or User authentication.

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.

Create new OAuth credentials to access the secure resources used in this tutorial.

Complete the Create OAuth credentials for user authentication tutorial to obtain a Client ID and Redirect URL.

A Client ID uniquely identifies your app on the authenticating server. If the server cannot find an app with the provided Client ID, it will not proceed with authentication.
The Redirect URL (also referred to as a callback url) is used to identify a response from the authenticating server when the system returns control back to your app after an OAuth login. Since it does not necessarily represent a valid endpoint that a user could navigate to, the redirect URL can use a custom scheme, such as my-app://auth. It is important to make sure the redirect URL used in your app's code matches a redirect URL configured on the authenticating server.
Copy and paste the Client ID and Redirect URL into a safe location. They will be used in a later step.

All users that access this application need account privileges to access the ArcGIS Basemap Styles service.

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... 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
```

Refactor the template 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. You will implement a stateful widget so your app is ready for this.

It is possible to display a map using a stateless widget implementation, see the Display map sample.

In VS Code, open lib/main.dart.

Inside main(), instantiate MaterialApp within runApp() and set the named argument, home, to an instance of MainApp.

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

    const MaterialApp(home: MainApp()),

  );
}

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.

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 in a later step.

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!'))),
    );

  }
}

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
```
Return to main.dart.

Import the arcgis_maps package.

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

Make platform specific configuration changes

To develop for Android, iOS, or both, the Flutter tooling sets default values for a number of configuration versions. These are pre-configured in a new project when it is created. The updates specified below are changes that are required to these defaults in order to compile an application using the current version of the ArcGIS Maps SDK for Flutter package. For additional details see our System Requirements page.

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

build.gradle.kts
Use dark colors for code blocks
// ...

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 = 28
    targetSdk = flutter.targetSdkVersion
    versionCode = flutter.versionCode
    versionName = flutter.versionName
}

// ...

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

AndroidManifest.xml
Use dark colors for code blocks

<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 17.0 minimum by editing the ios/Podfile file. Uncomment the line and update the version number.

Podfile
Use dark colors for code blocks

# Uncomment this line to define a global platform for your project
platform :ios, '17.0'

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

Podfile
Use dark colors for code blocks
target '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.

Pass your API key access token to the ArcGISEnvironment.

Return to 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 MaterialApp(home: 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.

Use the Authenticator toolkit component to manage your OAuth credentials.

Add the ArcGIS Maps SDK for Flutter Toolkit package to your app by following these instructions.

Define a final class member variable inside _MainAppState class, _oAuthUserConfiguration, and initialize it with OAuthUserConfiguration passing in the portalUri, clientId, and redirectUri values.

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

  final _oAuthUserConfiguration = OAuthUserConfiguration(
    portalUri: Uri.parse('https://www.arcgis.com'),
    clientId: 'YOUR_CLIENT_ID',
    redirectUri: Uri.parse('YOUR_REDIRECT_URL'),
  );

  @override
  Widget build(BuildContext context) {

  }
}

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

Add code during application sign-out to revoke all tokens, Authenticator.revokeOAuthTokens(), and clear all credentials, Authenticator.clearCredentials(), from the authenticator's credential store.

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

  final _oAuthUserConfiguration = OAuthUserConfiguration(
    portalUri: Uri.parse('https://www.arcgis.com'),
    clientId: 'YOUR_CLIENT_ID',
    redirectUri: Uri.parse('YOUR_REDIRECT_URL'),
  );

  @override
  void dispose() {
    Authenticator.revokeOAuthTokens().whenComplete(
      Authenticator.clearCredentials,
    );

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {

  }
}

During application sign-out, you should consider revoking all tokens and clearing all credentials from the credential stores based on your app requirements. Consult the Authenticator reference for details when using the toolkit component.

For Android only, a system browser is required for user authentication. Add the following activity to the Android manifest in your project:

android/app/src/main/AndroidManifest.xml
Use dark colors for code blocks
        <!-- ... -->

        <activity
            android:name="com.linusu.flutter_web_auth_2.CallbackActivity"
            android:exported="true">
            <intent-filter android:label="flutter_web_auth_2">
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="YOUR_CALLBACK_URL_SCHEME_HERE" />
            </intent-filter>
        </activity>

        <!-- ... -->

Replace YOUR_CALLBACK_URL_SCHEME_HERE with the scheme of the redirect URL used when you set up authentication earlier. This is necessary so that the browser can communicate back to your app after the login workflow completes.

For example, if you have a redirect URL, such as: my-app://auth, the value of the scheme would be: my-app. This value would replace YOUR_CALLBACK_URL_SCHEME_HERE in the activity.

Add a map

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

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

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) {

  }


}

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

  final _mapViewController = ArcGISMapView.createController();

  final _oAuthUserConfiguration = OAuthUserConfiguration(
    portalUri: Uri.parse('https://www.arcgis.com'),
    clientId: 'YOUR_CLIENT_ID',
    redirectUri: Uri.parse('YOUR_REDIRECT_URL'),
  );

  @override
  void dispose() {
    Authenticator.revokeOAuthTokens().whenComplete(
      Authenticator.clearCredentials,
    );

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {

  }
}

Add widgets to the widget tree within the build() consisting of Scaffold, Column, Expanded, and ArcGISMapView. Set the map view's named argument, controllerProvider, to the class member variable _mapViewController and the onMapViewReady argument to a new method with the same name as the argument. You will define the new method 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 73 74 75 76 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, ), ), ], ), ); } }
Add widgets to the widget tree within the build() consisting of Scaffold, Column, Expanded, Authenticator and ArcGISMapView. Set the authenticator's named argument, oAuthUserConfigurations, to the class member variable _oAuthUserConfiguration and make the ArcGISMapView widget a child of the authenticator. Lastly, set the map view's named argument, controllerProvider, to the class member variable _mapViewController and the onMapViewReady argument to a new method with the same name as the argument. You will define the new method 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. The Authenticator can be placed anywhere in your widget tree, though it makes the most sense to use it as the parent of the ArcGISMapView widget in this 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 class _MainAppState extends State<MainApp> { final _mapViewController = ArcGISMapView.createController(); final _oAuthUserConfiguration = OAuthUserConfiguration( portalUri: Uri.parse('https://www.arcgis.com'), clientId: 'YOUR_CLIENT_ID', redirectUri: Uri.parse('YOUR_REDIRECT_URL'), ); @override void dispose() { Authenticator.revokeOAuthTokens().whenComplete( Authenticator.clearCredentials, ); super.dispose(); } @override Widget build(BuildContext context) { return Scaffold( body: Column( children: [ Expanded( child: Authenticator( oAuthUserConfigurations: [_oAuthUserConfiguration], child: ArcGISMapView( controllerProvider: () => _mapViewController, onMapViewReady: onMapViewReady, ), ), ), ], ), ); } }

Define a new method within _MainAppState, onMapViewReady(), that does not return anything.

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

  }

Define a final variable, map, in the new method and initialize it to an ArcGISMap using the ArcGIS topographic basemap style.

main.dart
Use dark colors for code blocks
  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.

Scale is an integral part of creating a viewpoint. It determines how closely you view your map. Scale is a ratio between measurements on a map view and measurements in the real-world. Use this conversion tool to see how scale works relative to zoom level and learn more about their relationship.

main.dart
Use dark colors for code blocks
  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 code, you must add the authentication code and set the credentials that you created in the Set up authentication section.

Add authentication code and set developer credentials

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

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 MaterialApp(home: 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.

Add the Authenticator toolkit component to manage your OAuth credentials.

Add the ArcGIS Maps SDK for Flutter Toolkit package to your app by following these instructions

Add the following code to main.dart:

Define a final class member inside _MainAppState class, _oAuthUserConfiguration, and initialize it with OAuthUserConfiguration passing in the portalUri, clientId, and redirectUri values.
Add code to revoke all tokens, Authenticator.revokeOAuthTokens(), and clear all credentials, Authenticator.clearCredentials(), from the authenticator's credential store during application sign-out.
Add the Authenticator widget as a parent of the ArcGISMapView widget in the existing widget tree found in the build(). Set the value of the named parameter, oAuthUserConfigurations to a list containing the new member variable _oAuthUserConfiguration.

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

  final _mapViewController = ArcGISMapView.createController();

  final _oAuthUserConfiguration = OAuthUserConfiguration(
    portalUri: Uri.parse('https://www.arcgis.com'),
    clientId: 'YOUR_CLIENT_ID',
    redirectUri: Uri.parse('YOUR_REDIRECT_URL'),
  );

  @override
  void dispose() {
    Authenticator.revokeOAuthTokens().whenComplete(
      Authenticator.clearCredentials,
    );

    super.dispose();
  }

  @override
  Widget build(BuildContext context) {

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

  }
}