Display dimensions

View on GitHubSample viewer app

Display dimension features from a mobile map package.

Image showing the Display Dimensions sample

Use case

Dimensions show specific lengths or distances on a map. A dimension may indicate the length of a side of a building or land parcel, or the distance between two features, such as a fire hydrant and the corner of a building.

How to use the sample

When the sample loads, it will automatically display the map containing dimension features from the mobile map package. The name of the dimension layer containing the dimension features is displayed in the controls box. Control the visibility of the dimension layer with the "Dimension Settings" button, and apply a definition expression to show dimensions of greater than or equal to 450m in length using the "Definition Expression" switch.

How it works

  1. Create a MobileMapPackage specifying the path to the .mmpk file.
  2. Load the mobile map package with mobileMapPackage.load().
  3. After it successfully loads, get the first map from the mmpk and set it to the map view: mapView.map = mobileMapPackage.maps[0].
  4. Loop through the map's layers to create a DimensionLayer.
  5. Control the dimension layer's visibility with dimensionLayer.isVisible and set a definition expression with dimensionLayer.definitionExpression.

Relevant API

  • DimensionLayer
  • MobileMapPackage

About the data

This sample shows a subset of the Edinburgh, Scotland network of pylons, substations, and powerlines within an Edinburgh Pylon Dimensions mobile map package, digitized from satellite imagery. Note the data is intended as illustrative of the network only.

Additional information

Dimension layers can be taken offline from a feature service hosted on ArcGIS Enterprise 10.9 or later, using the GeodatabaseSyncTask. Dimension layers are also supported in mobile map packages or mobile geodatabases created in ArcGIS Pro 2.9 or later.

Tags

dimension, layer, mmpk, mobile map package, utility

Sample Code

MainActivity.ktMainActivity.ktDownloadActivity.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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/* Copyright 2023 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.displaydimensions

import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import androidx.databinding.DataBindingUtil
import androidx.lifecycle.lifecycleScope
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.mapping.MobileMapPackage
import com.arcgismaps.mapping.layers.DimensionLayer
import com.esri.arcgismaps.sample.displaydimensions.databinding.ActivityMainBinding
import com.esri.arcgismaps.sample.displaydimensions.databinding.DimensionsDialogLayoutBinding
import com.google.android.material.dialog.MaterialAlertDialogBuilder
import com.google.android.material.snackbar.Snackbar
import kotlinx.coroutines.launch
import java.io.File

class MainActivity : AppCompatActivity() {

    private val provisionPath: String by lazy {
        getExternalFilesDir(null)?.path.toString() + File.separator + getString(R.string.app_name)
    }

    private val activityMainBinding: ActivityMainBinding by lazy {
        DataBindingUtil.setContentView(this, R.layout.activity_main)
    }

    private val mapView by lazy {
        activityMainBinding.mapView
    }

    private val optionsButton by lazy {
        activityMainBinding.optionsButton
    }

    // keep an instance of the MapView's dimension layer
    private var dimensionLayer: DimensionLayer? = null

    // track if the layer is enabled
    private var isDimensionLayerEnabled: Boolean = true

    // track if the custom definition is enabled
    private var isDefinitionEnabled: Boolean = false

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // authentication with an API key or named user is
        // required to access basemaps and other location services
        ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.API_KEY)
        lifecycle.addObserver(mapView)

        // check if the .mmpk file exits
        val mmpkFile = File(provisionPath, getString(R.string.file_name))
        if (!mmpkFile.exists()) return showError("Mobile map package file does not exist.")

        // create and load a mobile map package
        val mobileMapPackage = MobileMapPackage(mmpkFile.path)

        lifecycleScope.launch {
            // load the mobile map package
            mobileMapPackage.load().getOrElse {
                return@launch showError("Failed to load the mobile map package: ${it.message}")
            }
            // if the loaded mobile map package does not contain a map
            if (mobileMapPackage.maps.isEmpty()) {
                return@launch showError("Mobile map package does not contain a map")
            }

            // add the map from the mobile map package to the map view,
            // and set a min scale to maintain dimension readability
            mapView.map = mobileMapPackage.maps[0]
            mapView.map?.minScale = 35000.0

            // set the dimension layer within the map
            dimensionLayer = mapView.map?.operationalLayers?.firstOrNull { layer ->
                layer is DimensionLayer
            } as DimensionLayer

        }

        optionsButton.setOnClickListener {
            // inflate the dialog layout and get references to each of its components
            val dialogBinding = DimensionsDialogLayoutBinding.inflate(layoutInflater)
            dialogBinding.dimensionLayerSwitch.apply {
                isChecked = isDimensionLayerEnabled
                setOnCheckedChangeListener { _, isEnabled ->
                    // set the visibility of the dimension layer
                    dimensionLayer?.isVisible = isEnabled
                    isDimensionLayerEnabled = isEnabled
                }
            }
            dialogBinding.definitionSwitch.apply {
                isChecked = isDefinitionEnabled
                setOnCheckedChangeListener { _, isEnabled ->
                    // set a definition expression to show dimension lengths of
                    // greater than or equal to 450m when the checkbox is selected,
                    // or to reset the definition expression to show all
                    // dimension lengths when unselected
                    val defExpression = if (isEnabled) "DIMLENGTH >= 450" else ""
                    dimensionLayer?.definitionExpression = defExpression
                    isDefinitionEnabled = isEnabled
                }
            }

            // set up the dialog
            MaterialAlertDialogBuilder(this).apply {
                setView(dialogBinding.root)
                setTitle("${getString(R.string.settings)}: ${dimensionLayer?.name}")
            }.show()
        }
    }

    private fun showError(message: String) {
        Log.e(localClassName, message)
        Snackbar.make(mapView, message, Snackbar.LENGTH_SHORT).show()
    }
}

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