Skip to content
View on GitHubSample viewer app

Specify a map's spatial reference.

Image of set spatial reference

Use case

Choosing the correct spatial reference is important for ensuring accurate projection of data points to a map.

How to use the sample

Pan and zoom around the map. Observe how the map is displayed using the World Bonne spatial reference.

How it works

  1. Instantiate an ArcGISMap object using a spatial reference e.g. ArcGISMap(SpatialReference(54024)).
  2. Instantiate a Basemap object using an ArcGISMapImageLayer object.
  3. Set the base map to the map.
  4. Set the map to the MapView.

The ArcGIS map image layer will now use the spatial reference set to the ArcGIS map (World Bonne (WKID: 54024)) and not it's default spatial reference.

Relevant API

  • ArcGISMap
  • ArcGISMapImageLayer
  • Basemap
  • MapView
  • SpatialReference

Additional information

Operational layers will automatically project to this spatial reference when possible.

Tags

project, WKID

Sample Code

SetSpatialReferenceViewModel.ktSetSpatialReferenceViewModel.ktMainActivity.ktSetSpatialReferenceScreen.kt
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
59
60
61
62
/* Copyright 2025 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
 *
 *    http://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.
 *
 */

package com.esri.arcgismaps.sample.setspatialreference.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.Basemap
import com.arcgismaps.geometry.SpatialReference
import com.arcgismaps.mapping.layers.ArcGISMapImageLayer
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

/**
 * ViewModel for the "Set Spatial Reference" sample.
 */
class SetSpatialReferenceViewModel(application: Application) : AndroidViewModel(application) {

    // Message dialog view model for presenting errors
    val messageDialogVM = MessageDialogViewModel()

    // Create a map using World Bonne spatial reference (WKID: 54024)
    var arcGISMap = ArcGISMap(spatialReference = SpatialReference(wkid = WORLD_BONNE_WKID)).apply {
        // Use an ArcGISMapImageLayer as the basemap's base layer so the
        // map image service will be displayed in the map's spatial reference.
        setBasemap(basemap = Basemap(baseLayer = ArcGISMapImageLayer(url = WORLD_CITIES_MAP_SERVICE)))
    }

    init {
        viewModelScope.launch {

                // Load the map and show an error dialog if loading fails.
                arcGISMap.load().onFailure { throwable ->
                    messageDialogVM.showMessageDialog(throwable)
                }
        }
    }

    companion object {
        // The spatial reference for the sample, World Bonne (WKID: 54024)
        private const val WORLD_BONNE_WKID = 54024

        // Map image service URL with World Bonne spatial reference.
        private const val WORLD_CITIES_MAP_SERVICE =
            "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer"
    }
}

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