Get started

There are a number of ways to get started to develop with ArcGIS Maps SDK for Flutter. If you are new, follow the steps below to get started with Flutter and Visual Studio Code.

1. Sign up for an account

To use ArcGIS Maps SDK for Flutter to access content, services, or an organization, you need an ArcGIS Location Platform account, ArcGIS Online account, or ArcGIS Enterprise account. The type of account, user type, and role you need depends on the resource you need to access and the operations you wish to undertake.

If you do not have an account, select one of the options below:

2. Get the SDK and dependencies

Install Flutter

1. Choose a supported development platform to get started. ArcGIS Maps SDK for Flutter supports macOS or Windows as a development platform.

2. Select a target platform (iOS or Android).

3. Follow the instructions.

Get the ArcGIS Maps SDK for Flutter:

Inside of VS Code's terminal

1. Run: dart pub add arcgis_maps.
2. Run: flutter pub upgrade.
3. Lastly, run dart run arcgis_maps install.

For more details, go to Install and set up.

3. Implement authentication

To access secure ArcGIS services and resources, you need to implement authentication. The easiest way to get started is to obtain an access token from an API Key and implement API key authentication. If you want to build an app that requires users to sign in with their ArcGIS account, implement user authentication.

4. Create your first mapping application

Follow the step-by-step instructions in the Display a map tutorial to create your first mapping application. The following code shows how you can create and display a map.

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
// Authenticate your application using a supported method:
// - API key authentication
// - User authentication

@override
Widget build(BuildContext context) {
  return Scaffold(
    // Add a map view to the widget tree and set a controller and a map with a basemap style.
    body: ArcGISMapView(
      controllerProvider: () => ArcGISMapView.createController()
        // Creates a map with the topographic basemap style.
        ..arcGISMap = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic),
    ),
  );
}

Once you are done building your application, make sure to license it before deploying to production. For more information, see License and deployment topic for details.

5. Follow the tutorials

Go to the tutorials to create and run applications to perform different operations.

Display a map

Create a map that uses a basemap service layer and zomm to a specified location.

6. Explore the samples

Go to the samples to learn how to perform more tasks with the API.

Display map

Display a map with an imagery basemap.

Display a scene

Display a scene with a terrain surface and some imagery.

Show device location

Display your current position on the map, as well as switch between different types of auto pan modes.

Find route

Display directions for a route between two points.