Set initial viewpoint

View on GitHub

Display the map at an initial viewpoint representing a bounding geometry.

Image of set initial viewpoint

Use case

Setting the initial viewpoint is useful when a user wishes to first load the map at a particular area of interest.

How to use the sample

When the sample loads, note the map is opened at the initial view point that is set to it.

How it works

  1. Instantiate an ArcGISMap object.
  2. Instantiate a Viewpoint object using an Envelope object.
  3. Set the starting location of the map with initialViewpoint.
  4. Set the map to an ArcGISMapView object.

Relevant API

  • ArcGISMap
  • ArcGISMapView
  • Envelope
  • Viewpoint

Tags

envelope, extent, initial viewpoint, zoom

Sample Code

set_initial_viewpoint.dart
Use dark colors for code blocksCopy
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
// 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 SetInitialViewpoint extends StatefulWidget {
  const SetInitialViewpoint({super.key});

  @override
  State<SetInitialViewpoint> createState() => _SetInitialViewpointState();
}

class _SetInitialViewpointState extends State<SetInitialViewpoint>
    with SampleStateSupport {
  // Create a controller for the map view.
  final _mapViewController = ArcGISMapView.createController();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: ArcGISMapView(
        controllerProvider: () => _mapViewController,
        onMapViewReady: onMapViewReady,
      ),
    );
  }

  void onMapViewReady() {
    // Create a map with a topographic basemap style.
    final map = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic);
    // Create an initial envelope.
    final initialEnvelope = Envelope.fromXY(
      xMin: -118.805,
      yMin: 34.027,
      xMax: -118.795,
      yMax: 34.037,
      spatialReference: SpatialReference.wgs84,
    );
    // Create and set the initial viewpoint to the map.
    map.initialViewpoint = Viewpoint.fromTargetExtent(initialEnvelope.extent);
    // Set the map to the map view.
    _mapViewController.arcGISMap = map;
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.