Display a web map | ArcGIS Maps SDK for Flutter

Learn how to create and display a map from a web map stored in ArcGIS.

A web map contains the definition of a map, including properties such as the basemap, initial extent, layers, styles, pop-ups, and labels. You can author and save web maps using the Map Viewer or ArcGIS Pro and share them in ArcGIS. Each web map is stored as an item in ArcGIS Online or ArcGIS Enterprise, allowing you to access a web map from a portal using its item ID and display it in your app.

In this tutorial, you use a web map's item ID to display a map of trails, trailheads and parks in the Santa Monica Mountains . The web map is hosted in ArcGIS Online.

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.

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

To start the tutorial, complete the Display a map tutorial. This creates a map to display the Santa Monica Mountains in California using the topographic basemap from the ArcGIS Basemap Styles service.

Open a Flutter project

Open the project you created by completing the Display a map tutorial.
Continue with the following instructions to display a map from a web map stored in ArcGIS.

Get the web map item ID

You can use ArcGIS tools to create and view web maps. Use the Map Viewer to identify the web map item ID. This item ID will be used later in the tutorial.

Go to the LA Trails and Parks web map in the Map Viewer in ArcGIS Online. This web map displays trails, trailheads and parks in the Santa Monica Mountains.
Make a note of the item ID at the end of the browser's URL. The item ID should be
41281c51f9de45edaf1c8ed44bb10e30

Display the web map

You can create a map from a web map using the web map's item ID. Use the PortalItem class to access the web map and the ArcGISMap class to create and display a map from it.

Open lib\main.dart.

In onMapViewReady(), remove the code that creates a map and sets a Viewpoint on the map view controller.

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

  }

Create a PortalItem for the web map. To do this, provide a Portal referencing ArcGIS Online and the web map's item ID.

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

    // Create a portal item connecting to ArcGIS Online as a Portal and a web
    // map using its item ID.
    PortalItem portalItem = PortalItem.withPortalAndItemId(
      portal: Portal.arcGISOnline(),
      itemId: '41281c51f9de45edaf1c8ed44bb10e30',
    );

    _mapViewController.arcGISMap = map;

  }

Create ArcGISMap using the portal item.

main.dart
Use dark colors for code blocks
    // Create a portal item connecting to ArcGIS Online as a Portal and a web
    // map using its item ID.
    PortalItem portalItem = PortalItem.withPortalAndItemId(
      portal: Portal.arcGISOnline(),
      itemId: '41281c51f9de45edaf1c8ed44bb10e30',
    );

    // Create a map using the portal item.
    final map = ArcGISMap.withItem(portalItem);

    _mapViewController.arcGISMap = map;

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 should see a map of trails, trailheads and parks in the Santa Monica Mountains. 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 first set up authentication to create credentials, then add authentication code and set the developer credentials to the solution.

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.

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,
              ),
            ),
          ),
        ],
      ),
    );

  }
}

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.

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.

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 should see a map of trails, trailheads and parks in the Santa Monica Mountains. Pinch, drag, and double-tap the map view to explore the map.