Add map image layer

View on GitHub

Display a layer from an ArcGIS map image layer service.

Image of add map image layer

Use case

Map image layers are also referred to as dynamic map services. These services generate images dynamically on the server and send the resulting image to the requesting client. This is useful when rendering complex cartography or large amounts of data in a connected environment, as the client simply displays the image that the server returns. This can result in more accurate and faster-performing layers.

How to use the sample

Run the sample and view the map image layer. As you navigate the map, the layer issues image requests for the new map extent. The resulting images are rendered on the screen.

How it works

Create an instance of ArcGISMap.
Create an ArcGISMapImageLayer with the URL to a map image service.
Add it to the map's operational layers collection.

Relevant API

ArcGISMapImageLayer

Sample Code

add_map_image_layer.dart
Use dark colors for code blocksCopy
//
// Copyright 2024 Esri
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

import 'package:arcgis_maps/arcgis_maps.dart';
import 'package:arcgis_maps_sdk_flutter_samples/utils/sample_state_support.dart';
import 'package:flutter/material.dart';

class AddMapImageLayer extends StatefulWidget {
  const AddMapImageLayer({super.key});

  @override
  State<AddMapImageLayer> createState() => _AddMapImageLayerState();
}

class _AddMapImageLayerState extends State<AddMapImageLayer>
    with SampleStateSupport {
  // Create a map view controller.
  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      // Add a map view to the widget tree and set a controller.
      body: ArcGISMapView(
        controllerProvider: () => _mapViewController,
        onMapViewReady: onMapViewReady,
      ),
    );
  }

  void onMapViewReady() async {
    // Create a map with a map image layer.
    final map = ArcGISMap();
    // Create a map image layer with a uri.
    final mapImageLayer = ArcGISMapImageLayer.withUri(
      Uri.parse(
        'https://sampleserver5.arcgisonline.com/arcgis/rest/services/Elevation/WorldElevations/MapServer',
      ),
    );
    // Add the map image layer to the map.
    map.operationalLayers.add(mapImageLayer);
    // Load the map image layer.
    await mapImageLayer.load();
    // Set the map on the map view controller.
    _mapViewController.arcGISMap = map;
  }
}