Learn how to create and display a map
A map contains layers
In this tutorial, you create and display a map
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
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
API key credentials are an item that contains the parameters used to create and manage long-lived access tokens for API key authentication. They are a type of developer credential. with the correct privileges. - API keys
An API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications. 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
An ArcGIS account is an identity with a user type and set of privileges that can access specific ArcGIS products, tools, APIs, services, and resources. The main account types that can be used for development are an ArcGIS Location Platform account, ArcGIS Online account, and ArcGIS Enterprise account. ArcGIS Location Platform and ArcGIS Online accounts are also associated with a subscription. . - User accounts must have privilege
Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. to access the ArcGIS servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise. used in application. - Requires creating OAuth credentials
OAuth credentials are an item that contains parameters required to implement user authentication or app authentication, including a .client_id,client_secret, and redirect URIs. They are a type of developer credential. - 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
-
Complete the Create an API key tutorial and create an API key with the following privilege(s)
Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. :- Privileges
- Location services > Basemaps
- Privileges
-
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 IDuniquely 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 asmy-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
Develop or download
You have two options for completing this tutorial:
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.
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(), instantiateMaterialAppwithinrunApp()and set the named argument,home, to an instance ofMainApp.main.dartvoid main() {runApp(const MaterialApp(home: MainApp()),);} -
Refactor the template
MainAppclass definition to extendStatefulWidget. Hover your mouse over theStatelessWidgetkeyword, right-click, select Refactor…, and chose Convert to StatefulWidget to refactor your code.main.dartclass MainApp extends StatefulWidget {const MainApp({super.key});@overrideState<MainApp> createState() => _MainAppState();}class _MainAppState extends State<MainApp> {@overrideWidget build(BuildContext context) {return const MaterialApp(home: Scaffold(body: Center(child: Text('Hello World!'))),);}} -
Remove the
MaterialAppwidget 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.dartclass _MainAppState extends State<MainApp> {@overrideWidget 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:
cd display_a_map -
Run:
dart pub add arcgis_maps -
Run:
flutter pub upgrade -
Lastly, run:
dart run arcgis_maps install -
Return to main.dart.
-
Import the
arcgis_mapspackage.main.dartimport '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.ktsfile in your project:build.gradle.kts// ...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 = 28targetSdk = flutter.targetSdkVersionversionCode = flutter.versionCodeversionName = flutter.versionName}// ... -
Add a permission to
android/app/src/main/AndroidManifest.xmlto access online resources:AndroidManifest.xml<manifest xmlns:android="http://schemas.android.com/apk/res/android"><uses-permission android:name="android.permission.INTERNET" /><applicationandroid:label="display_a_map"android:name="${applicationName}"android:icon="@mipmap/ic_launcher"><!-- ... -->
-
Set iOS 17.0 minimum by editing the
ios/Podfilefile. Uncomment the line and update the version number.Podfile# Uncomment this line to define a global platform for your projectplatform :ios, '17.0' -
Add the
Runtimecoreandarcgis_maps_ffipods to theRunnertarget section.Podfiletarget 'Runner' douse_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' doinherit! :search_pathsendend -
Use
pod updateto configure Pods.cd ios && pod update && cd ..
Set developer credentials
To allow your app users to access ArcGIS location services
Pass your API key access token to the ArcGISEnvironment.
-
Return to main.dart.
-
In the
main()function, set theArcGISEnvironment.apiKeyvalue to your access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. .main.dartvoid 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 credentialsclient_id, client_secret, and redirect URIs. They are a type of developer credential.
-
Add the ArcGIS Maps SDK for Flutter Toolkit package to your app by following these instructions.
-
Define a final class member variable inside
_MainAppStateclass,_oAuthUserConfiguration, and initialize it withOAuthUserConfigurationpassing in theportalUri,clientId, andredirectUrivalues.main.dartclass _MainAppState extends State<MainApp> {final _oAuthUserConfiguration = OAuthUserConfiguration(portalUri: Uri.parse('https://www.arcgis.com'),clientId: 'YOUR_CLIENT_ID',redirectUri: Uri.parse('YOUR_REDIRECT_URL'),);@overrideWidget 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.dartclass _MainAppState extends State<MainApp> {final _oAuthUserConfiguration = OAuthUserConfiguration(portalUri: Uri.parse('https://www.arcgis.com'),clientId: 'YOUR_CLIENT_ID',redirectUri: Uri.parse('YOUR_REDIRECT_URL'),);@overridevoid dispose() {Authenticator.revokeOAuthTokens().whenComplete(Authenticator.clearCredentials,);super.dispose();}@overrideWidget 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
Authenticatorreference for details when using the toolkit component. -
For Android only, a system browser is required for user authentication
User authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0. . Add the following activity to the Android manifest in your project:android/app/src/main/AndroidManifest.xml<!-- ... --><activityandroid: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_HEREwith 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_HEREin the activity.
Add a map
Create a map
-
Define a final class member variable inside
_MainAppStateclass,_mapViewController, and initialize it withArcGISMapViewControllerby calling thecreateController()onArcGISMapView.The ArcGIS map view controller is a user interface control that displays two-dimensional (2D) geographic content defined by an
ArcGISMap.main.dartclass _MainAppState extends State<MainApp> {final _mapViewController = ArcGISMapView.createController();@overrideWidget build(BuildContext context) {}}main.dartclass _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'),);@overridevoid dispose() {Authenticator.revokeOAuthTokens().whenComplete(Authenticator.clearCredentials,);super.dispose();}@overrideWidget build(BuildContext context) {}} -
Add widgets to the widget tree within the
build()consisting ofScaffold,Column,Expanded, andArcGISMapView. Set the map view’s named argument,controllerProvider, to the class member variable_mapViewControllerand theonMapViewReadyargument to a new method with the same name as the argument. You will define the new method next.The
Scaffoldwidget provides a basic material design visual layout structure, while theColumnwidget displays its children in a vertical array. TheArcGISMapViewwidget 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 anArcGISMapViewwithin aColumnwidget, which would give it unbounded size, would produce such an exception. Instead, you could wrap theArcGISMapViewin anExpandedwidget to provide it proper bounds as illustrated in this step of the tutorial.main.dartclass _MainAppState extends State<MainApp> {final _mapViewController = ArcGISMapView.createController();@overrideWidget 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 ofScaffold,Column,Expanded,AuthenticatorandArcGISMapView. Set the authenticator’s named argument,oAuthUserConfigurations, to the class member variable_oAuthUserConfigurationand make theArcGISMapViewwidget a child of the authenticator. Lastly, set the map view’s named argument,controllerProvider, to the class member variable_mapViewControllerand theonMapViewReadyargument to a new method with the same name as the argument. You will define the new method next.The
Scaffoldwidget provides a basic material design visual layout structure, while theColumnwidget displays its children in a vertical array. TheArcGISMapViewwidget 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 anArcGISMapViewwithin aColumnwidget, which would give it unbounded size, would produce such an exception. Instead, you could wrap theArcGISMapViewin anExpandedwidget to provide it proper bounds as illustrated in this step of the tutorial. TheAuthenticatorcan be placed anywhere in your widget tree, though it makes the most sense to use it as the parent of theArcGISMapViewwidget in this tutorial.main.dartclass _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'),);@overridevoid dispose() {Authenticator.revokeOAuthTokens().whenComplete(Authenticator.clearCredentials,);super.dispose();}@overrideWidget 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.dartvoid onMapViewReady() {} -
Define a final variable,
map, in the new method and initialize it to anArcGISMapusing the ArcGIS topographic basemap style.main.dartvoid onMapViewReady() {final map = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic);} -
Set the ArcGIS map view controller’s
arcGISMapproperty to themap. In addition, callsetViewpoint()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.dartvoid 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
Alternatively, you can download the tutorial solution, as follows.
Option 2: Download the solution
-
Click the
Download solutionlink underSolutionand 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
-
Open lib/main.dart.
-
In the
main()function, set theArcGISEnvironment.apiKeyvalue to your access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. .main.dartvoid 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
_MainAppStateclass,_oAuthUserConfiguration, and initialize it withOAuthUserConfigurationpassing in theportalUri,clientId, andredirectUrivalues. - 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
Authenticatorwidget as a parent of theArcGISMapViewwidget in the existing widget tree found in thebuild(). Set the value of the named parameter,oAuthUserConfigurationsto a list containing the new member variable_oAuthUserConfiguration.
main.dartclass _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'),);@overridevoid dispose() {Authenticator.revokeOAuthTokens().whenComplete(Authenticator.clearCredentials,);super.dispose();}@overrideWidget 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.
- Define a final class member inside
-
For Android only, a system browser is required for user authentication
User authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0. . Add the following activity to the Android manifest in your project:android/app/src/main/AndroidManifest.xml<!-- ... --><activityandroid: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_HEREwith 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_HEREin the activity.
Run the application
Follow these steps to run the application.
-
In VS Code’s terminal, run:
flutter pub upgrade -
Run:
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