Skip to content
View on GitHubSample viewer app

Use the Geometry Editor to create new point, multipoint, polyline, or polygon geometries or to edit existing geometries by interacting with a map view.

CreateAndEditGeometries

Use case

A field worker can mark features of interest on a map using an appropriate geometry. Features such as sample or observation locations, fences or pipelines, and building footprints can be digitized using point, multipoint, polyline, and polygon geometry types. Polyline and polygon geometries can be created and edited using a vertex-based creation and editing tool (i.e. vertex locations specified explicitly via tapping), or using a freehand tool.

How to use the sample

To create a new geometry, press the button appropriate for the geometry type you want to create (i.e. points, multipoints, polyline, or polygon) and interactively tap and drag on the map view to create the geometry.

To edit an existing geometry, tap the geometry to be edited in the map and then perform edits by tapping and dragging its elements.

When the whole geometry is selected, you can use the control handles to scale and rotate the geometry.

If creating or editing polyline or polygon geometries, choose the desired creation/editing tool (i.e. VertexTool, ReticleVertexTool, FreehandTool, or one of the available ShapeTools).

When using the ReticleVertexTool, you can move the map position of the reticle by dragging and zooming the map. Insert a vertex under the reticle by tapping on the map. Move a vertex by tapping when the reticle is located over a vertex, drag the map to move the position of the reticle, then tap a second time to place the vertex.

Use the control panel to undo or redo changes made to the geometry, delete a selected element, save the geometry, stop the editing session and discard any edits, and remove all geometries from the map.

How it works

  1. Create a MapViewProxy for interacting with the composable MapView.
  2. Create a GeometryEditor for creating and editing Geometrys.
  3. Create VertexTool, ReticleVertexTool, FreehandTool, or ShapeTool objects to define how the user interacts with the view to create or edit geometries, and set the geometry editor tool using the geometryEditor.tool property.
  4. Edit a tool's InteractionConfiguration to set the GeometryEditorScaleMode to allow either uniform or stretch scale mode.
  5. Create a MapView with MapView using MapView(mapViewProxy = MapViewProxy, geometryEditor = GeometryEditor, ...).
  6. Start the GeometryEditor using GeometryEditor.start(GeometryType) to create a new geometry or GeometryEditor.start(Geometry) to edit an existing geometry.
    • If using the Geometry Editor to edit an existing geometry, the geometry must be retrieved from the graphics overlay being used to visualize the geometry prior to calling the start method. To do this:
      • Use MapViewProxy.identifyGraphicsOverlays(...) to identify graphics at the location of a tap.
      • Find the desired IdentifyGraphicsOverlayResult in the list returned by MapViewProxy.identifyGraphicsOverlays(...).
      • Find the desired graphic in the IdentifyGraphicsOverlayResult.graphics list.
      • Access the geometry associated with the Graphic using Graphic.geometry - this will be used in the GeometryEditor.start(Geometry) method.
  7. Check to see if undo and redo are possible during an editing session using GeometryEditor.canUndo and GeometryEditor.canRedo. If it's possible, use GeometryEditor.undo() and GeometryEditor.redo().
  8. Check whether the currently selected GeometryEditorElement can be deleted (GeometryEditor.selectedElement.canDelete). If the element can be deleted, delete using GeometryEditor.deleteSelectedElement.
  9. Call GeometryEditor.stop() to finish the editing session. The GeometryEditor does not automatically handle the visualization of a geometry output from an editing session. This must be done manually by propagating the geometry returned by GeometryEditor.stop() into a Graphic added to a GraphicsOverlay.
    • To create a new Graphic in the GraphicsOverlay:
      • Using Graphic(Geometry), create a new Graphic with the geometry returned by the GeometryEditor.stop() method.
      • Add the Graphic to the GraphicsOverlay's list of Graphics (i.e. GraphicsOverlay.graphics.add(Graphic)).
    • To update the geometry underlying an existing Graphic in the GraphicsOverlay:
      • Replace the existing Graphic's Geometry property with the geometry returned by the GeometryEditor.stop().

Relevant API

  • Geometry
  • GeometryEditor
  • Graphic
  • GraphicsOverlay
  • MapView

Additional information

The sample opens with the ArcGIS Imagery basemap centered on the island of Inis Meáin (Aran Islands) in Ireland. Inis Meáin comprises a landscape of interlinked stone walls, roads, buildings, archaeological sites, and geological features, producing complex geometrical relationships.

This sample uses the GeoView-Compose Toolkit module to be able to implement a composable MapView.

Tags

draw, edit, freehand, geometry editor, geoview-compose, sketch, toolkit, vertex

Sample Code

CreateAndEditGeometriesViewModel.ktCreateAndEditGeometriesViewModel.ktMainActivity.ktCreateAndEditGeometriesScreen.ktButtonMenu.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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 /* 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.createandeditgeometries.components  import android.app.Application import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.ui.unit.dp import androidx.lifecycle.AndroidViewModel import androidx.lifecycle.viewModelScope import com.arcgismaps.Color import com.arcgismaps.geometry.Envelope import com.arcgismaps.geometry.Geometry import com.arcgismaps.geometry.GeometryType import com.arcgismaps.geometry.Multipoint import com.arcgismaps.geometry.Point import com.arcgismaps.geometry.Polygon import com.arcgismaps.geometry.Polyline import com.arcgismaps.mapping.ArcGISMap import com.arcgismaps.mapping.BasemapStyle import com.arcgismaps.mapping.Viewpoint import com.arcgismaps.mapping.symbology.SimpleFillSymbol import com.arcgismaps.mapping.symbology.SimpleFillSymbolStyle import com.arcgismaps.mapping.symbology.SimpleLineSymbol import com.arcgismaps.mapping.symbology.SimpleLineSymbolStyle import com.arcgismaps.mapping.symbology.SimpleMarkerSymbol import com.arcgismaps.mapping.symbology.SimpleMarkerSymbolStyle import com.arcgismaps.mapping.view.Graphic import com.arcgismaps.mapping.view.GraphicsOverlay import com.arcgismaps.mapping.view.SingleTapConfirmedEvent import com.arcgismaps.mapping.view.geometryeditor.FreehandTool import com.arcgismaps.mapping.view.geometryeditor.GeometryEditor import com.arcgismaps.mapping.view.geometryeditor.GeometryEditorScaleMode import com.arcgismaps.mapping.view.geometryeditor.ReticleVertexTool import com.arcgismaps.mapping.view.geometryeditor.ShapeTool import com.arcgismaps.mapping.view.geometryeditor.ShapeToolType import com.arcgismaps.mapping.view.geometryeditor.VertexTool import com.arcgismaps.toolkit.geoviewcompose.MapViewProxy import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.asStateFlow import kotlinx.coroutines.launch  class CreateAndEditGeometriesViewModel(application: Application) : AndroidViewModel(application) {  // create a map with the imagery basemap style  val arcGISMap by mutableStateOf(  ArcGISMap(BasemapStyle.ArcGISImagery).apply {  // a viewpoint centered at the island of Inis Meáin (Aran Islands) in Ireland  initialViewpoint = Viewpoint(  latitude = 53.08275,  longitude = -9.5933,  scale = 5000.0  )  }  )   // create a message dialog view model for handling error messages  val messageDialogVM = MessageDialogViewModel()   // create a MapViewProxy that will be used to identify features in the MapView and set the viewpoint  val mapViewProxy = MapViewProxy()   // create a graphic to hold graphics identified on tap  private var identifiedGraphic = Graphic()  // create a graphics overlay  val graphicsOverlay = GraphicsOverlay()  // create a geometry editor  val geometryEditor = GeometryEditor()   /**  * Enum of GeometryEditorTool types.  */  enum class ToolType {  Vertex,  ReticleVertex,  Freehand,  Arrow,  Ellipse,  Rectangle,  Triangle  }   /**  * Enum of GeometryEditorScaleMode types.  */  enum class ScaleOption {  Stretch,  Uniform  }   private val vertexTool = VertexTool()  private val reticleVertexTool = ReticleVertexTool()  private val freehandTool = FreehandTool()  private val arrowTool = ShapeTool(ShapeToolType.Arrow)  private val ellipseTool = ShapeTool(ShapeToolType.Ellipse)  private val rectangleTool = ShapeTool(ShapeToolType.Rectangle)  private val triangleTool = ShapeTool(ShapeToolType.Triangle)   private val _selectedTool = MutableStateFlow(ToolType.Vertex)  val selectedTool = _selectedTool.asStateFlow()   private val _currentGeometryType = MutableStateFlow<GeometryType>(GeometryType.Unknown)  val currentGeometryType = _currentGeometryType.asStateFlow()   private val _currentScaleOption = MutableStateFlow(ScaleOption.Stretch)  val currentScaleOption = _currentScaleOption.asStateFlow()   // create symbols for displaying new geometries  private val pointSymbol = SimpleMarkerSymbol(  style = SimpleMarkerSymbolStyle.Square,  color = Color.red,  size = 10f  )  private val multiPointSymbol = SimpleMarkerSymbol(  style = SimpleMarkerSymbolStyle.Circle,  color = Color.yellow,  size = 5f  )  private val polylineSymbol = SimpleLineSymbol(  style = SimpleLineSymbolStyle.Solid,  color = Color.blue,  width = 2f  )  private val polygonLineSymbol = SimpleLineSymbol(  style = SimpleLineSymbolStyle.Dash,  color = Color.black,  width = 1f  )  private val polygonSymbol = SimpleFillSymbol(  style = SimpleFillSymbolStyle.Solid,  color = Color.fromRgba(r = 255, g = 0, b = 0, a = 100),  outline = polygonLineSymbol  )   init {  viewModelScope.launch {  // load the map  arcGISMap.load().onFailure { error ->  messageDialogVM.showMessageDialog(  title = "Failed to load map",  description = error.message.toString()  )  }.onSuccess {  // create graphics for the initial geometries and add them to the graphics overlay  graphicsOverlay.graphics.addAll(  listOf(  Graphic(  geometry = Geometry.fromJsonOrNull(houseCoordinatesJson),  symbol = pointSymbol  ),  Graphic(  geometry = Geometry.fromJsonOrNull(outbuildingCoordinatesJson),  symbol = multiPointSymbol  ),  Graphic(  geometry = Geometry.fromJsonOrNull(road1CoordinatesJson),  symbol = polylineSymbol  ),  Graphic(  geometry = Geometry.fromJsonOrNull(road2CoordinatesJson),  symbol = polylineSymbol  ),  Graphic(  geometry = Geometry.fromJsonOrNull(boundaryCoordinatesJson),  symbol = polygonSymbol  )  )  )  }  }  }   /**  * Starts the GeometryEditor using the selected [GeometryType].  */  fun startEditor(selectedGeometry: GeometryType) {  if (!geometryEditor.isStarted.value) {  geometryEditor.start(selectedGeometry)  _currentGeometryType.value = selectedGeometry  if (selectedGeometry == GeometryType.Point || selectedGeometry == GeometryType.Multipoint) {  // default to vertex tool for point or multipoint  changeTool(ToolType.Vertex)  }  }  }   /**  * Stops the GeometryEditor and updates the identified graphic or calls [createGraphic].  */  fun stopEditor() {  // check if there was a previously identified graphic  if (identifiedGraphic.geometry != null) {  // update the identified graphic  identifiedGraphic.geometry = geometryEditor.stop()  // deselect the identified graphic  identifiedGraphic.isSelected = false  } else if (geometryEditor.isStarted.value) {  // create a graphic from the geometry that was being edited  createGraphic()  }  _currentGeometryType.value = GeometryType.Unknown  }   /**  * Undoes all edits made using the GeometryEditor then calls [stopEditor].  */  fun discardEdits() {  while (geometryEditor.canUndo.value) {  geometryEditor.undo()  }  stopEditor()  }   /**  * Deletes the selected element.  */  fun deleteSelectedElement() {  if (geometryEditor.selectedElement.value != null) {  geometryEditor.deleteSelectedElement()  }  }   /**  * Deletes all the geometries on the map.  */  fun deleteAllGeometries() {  graphicsOverlay.graphics.clear()  }   /**  * Undoes the last event on the geometry editor if possible.  */  fun undoEdit() {  if (geometryEditor.canUndo.value) {  geometryEditor.undo()  }  }   /**  * Redoes the last event on the geometry editor if possible.  */  fun redoEdit() {  if (geometryEditor.canRedo.value) {  geometryEditor.redo()  }  }   /**  * Changes the tool type of the geometry editor to the specified tool.  */  fun changeTool(toolType: ToolType) {  when (toolType) {  ToolType.Vertex -> geometryEditor.tool = vertexTool  ToolType.ReticleVertex -> geometryEditor.tool = reticleVertexTool  ToolType.Freehand -> geometryEditor.tool = freehandTool  ToolType.Arrow -> geometryEditor.tool = arrowTool  ToolType.Ellipse -> geometryEditor.tool = ellipseTool  ToolType.Rectangle -> geometryEditor.tool = rectangleTool  ToolType.Triangle -> geometryEditor.tool = triangleTool  }   // enable snapping and haptic feedback on snapping for reticle tool only  val enableSnappingAndHaptics = (toolType == ToolType.ReticleVertex)  geometryEditor.snapSettings.isEnabled = enableSnappingAndHaptics  geometryEditor.snapSettings.isHapticFeedbackEnabled = enableSnappingAndHaptics  geometryEditor.snapSettings.sourceSettings.forEach {  it.isEnabled = enableSnappingAndHaptics  }   _selectedTool.value = toolType  }   /**  * Changes the scale option of the current geometry editor tool to the specified scale option.  */  fun changeScaleOption(scaleOption: ScaleOption) {  val newScaleOption =  when (scaleOption) {  ScaleOption.Stretch -> GeometryEditorScaleMode.Stretch  ScaleOption.Uniform -> GeometryEditorScaleMode.Uniform  }   // update the scale option setting in the configurations of the tools that support it  vertexTool.configuration.scaleMode = newScaleOption  freehandTool.configuration.scaleMode = newScaleOption  arrowTool.configuration.scaleMode = newScaleOption  ellipseTool.configuration.scaleMode = newScaleOption  rectangleTool.configuration.scaleMode = newScaleOption  triangleTool.configuration.scaleMode = newScaleOption   _currentScaleOption.value = scaleOption  }   /**  * Creates a graphic from the geometry and adds it to the GraphicsOverlay.  */  private fun createGraphic() {  // stop the geometry editor and get its final geometry state  val geometry = geometryEditor.stop()  ?: return messageDialogVM.showMessageDialog(  title = "Error!",  description = "Error stopping editing session"  )   // create a graphic to represent the new geometry  val graphic = Graphic(geometry)   // give the graphic an appropriate fill based on the geometry type  when (geometry) {  is Point -> graphic.symbol = pointSymbol  is Multipoint -> graphic.symbol = multiPointSymbol  is Polyline -> graphic.symbol = polylineSymbol  is Polygon -> graphic.symbol = polygonSymbol  else -> {}  }  // add the graphic to the graphics overlay  graphicsOverlay.graphics.add(graphic)  // deselect the graphic  graphic.isSelected = false  }   /**  * Identifies the graphic at the tapped screen coordinate in the provided [singleTapConfirmedEvent]  * and starts the GeometryEditor using the identified graphic's geometry. Hide the BottomSheet on  * [singleTapConfirmedEvent].  */  fun identify(singleTapConfirmedEvent: SingleTapConfirmedEvent) {  viewModelScope.launch {  // attempt to identify a graphic at the location the user tapped  val graphicsResult = mapViewProxy.identifyGraphicsOverlays(  screenCoordinate = singleTapConfirmedEvent.screenCoordinate,  tolerance = 10.0.dp,  returnPopupsOnly = false  ).getOrNull()   if (!geometryEditor.isStarted.value) {  if (graphicsResult != null) {  if (graphicsResult.isNotEmpty()) {  // get the tapped graphic  identifiedGraphic = graphicsResult.first().graphics.first()  // select the graphic  identifiedGraphic.isSelected = true  // start the geometry editor with the identified graphic  identifiedGraphic.geometry?.let {  geometryEditor.start(it)  when (it) {  is Envelope -> _currentGeometryType.value = GeometryType.Envelope  is Polygon -> _currentGeometryType.value = GeometryType.Polygon  is Polyline -> _currentGeometryType.value = GeometryType.Polyline  is Multipoint -> _currentGeometryType.value = GeometryType.Multipoint  is Point -> _currentGeometryType.value = GeometryType.Point  }  }  }  }  // reset the identified graphic back to null  identifiedGraphic.geometry = null  }  }  }   // json formatted strings for initial geometries  private val houseCoordinatesJson = """{"x": -1067898.59, "y": 6998366.62,  "spatialReference": {"latestWkid":3857, "wkid":102100}}"""   private val outbuildingCoordinatesJson = """{"points":[[-1067984.26,6998346.28],[-1067966.80,6998244.84],  [-1067921.88,6998284.65],[-1067934.36,6998340.74],  [-1067917.93,6998373.97],[-1067828.30,6998355.28],  [-1067832.25,6998339.70],[-1067823.10,6998336.93],  [-1067873.22,6998386.78],[-1067896.72,6998244.49]],  "spatialReference":{"latestWkid":3857,"wkid":102100}}"""   private val road1CoordinatesJson = """{"paths":[[[-1068095.40,6998123.52],[-1068086.16,6998134.60],  [-1068083.20,6998160.44],[-1068104.27,6998205.37],  [-1068070.63,6998255.22],[-1068014.44,6998291.54],  [-1067952.33,6998351.85],[-1067927.93,6998386.93],  [-1067907.97,6998396.78],[-1067889.86,6998406.63],  [-1067848.08,6998495.26],[-1067832.92,6998521.11]]],  "spatialReference":{"latestWkid":3857,"wkid":102100}}"""   private val road2CoordinatesJson = """{"paths":[[[-1067999.28,6998061.97],[-1067994.48,6998086.59],  [-1067964.53,6998125.37],[-1067952.70,6998215.84],  [-1067923.13,6998347.54],[-1067903.90,6998391.86],  [-1067895.40,6998422.02],[-1067891.70,6998460.18],  [-1067889.49,6998483.56],[-1067880.98,6998527.26]]],  "spatialReference":{"latestWkid":3857,"wkid":102100}}"""   private val boundaryCoordinatesJson = """{ "rings": [[[-1067943.67,6998403.86],[-1067938.17,6998427.60],  [-1067898.77,6998415.86],[-1067888.26,6998398.80],  [-1067800.85,6998372.93],[-1067799.61,6998342.81],  [-1067809.38,6998330.00],[-1067817.07,6998307.85],  [-1067838.07,6998285.34],[-1067849.10,6998250.38],  [-1067874.02,6998256.00],[-1067879.87,6998235.95],  [-1067913.41,6998245.03],[-1067934.84,6998291.34],  [-1067948.41,6998251.90],[-1067961.18,6998186.68],  [-1068008.59,6998199.49],[-1068052.89,6998225.45],  [-1068039.37,6998261.11],[-1068064.12,6998265.26],  [-1068043.32,6998299.88],[-1068036.25,6998327.93],  [-1068004.43,6998409.28],[-1067943.67,6998403.86]]],  "spatialReference":{"latestWkid":3857,"wkid":102100}}"""   /**  * Define a blue color for polylines.  */  private val Color.Companion.blue: Color  get() {  return fromRgba(0, 0, 255, 255)  }  }

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