Skip to content
View on GitHubSample viewer app

Display a shapefile with custom symbology.

Image of apply symbology to shapefile

Use case

Feature layers created from shapefiles do not possess any rendering information, and will be assigned with a default symbology. You can apply custom styling to ensure that the content is visible and usable in the context of a specific map. For example, you could use this to visually differentiate between features originating from two different shapefiles, by applying a blue color to one, and a red color to the other.

How to use the sample

Pan and zoom the map to view the custom renderer applied to the feature layer created from the shapefile.

How it works

  1. Create a ShapefileFeatureTable, providing the path to a shapefile.
  2. Create a FeatureLayer and associate it with the ShapeFileFeatureTable.
  3. Create a SimpleRenderer to override the default symbology. The simple renderer takes a symbol and applies that to all features in a layer.
  4. Apply the renderer to the FeatureLayer by setting the renderer.

Relevant API

  • FeatureLayer
  • ShapefileFeatureTable
  • SimpleFillSymbol
  • SimpleLineSymbol
  • SimpleRenderer

Offline data

This sample uses the Aurora Subdivisions Shapefile. It is downloaded from ArcGIS Online automatically.

About the data

This sample displays a shapefile containing subdivisions in Aurora, CO.

Additional information

While shapefiles contain no rendering information, other data sources such as Service Feature Tables or Geodatabase Feature Tables can contain such information. As a result, the rendering properties of the other data sources can be pre-defined by the author.

Tags

package, shape file, shapefile, symbology, visualization

Sample Code

ApplySymbologyToShapefileViewModel.ktApplySymbologyToShapefileViewModel.ktMainActivity.ktDownloadActivity.ktApplySymbologyToShapefileScreen.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
/* 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.applysymbologytoshapefile.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.Color
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.FeatureLayer
import com.arcgismaps.data.ShapefileFeatureTable
import com.arcgismaps.mapping.symbology.SimpleLineSymbol
import com.arcgismaps.mapping.symbology.SimpleLineSymbolStyle
import com.arcgismaps.mapping.symbology.SimpleFillSymbol
import com.arcgismaps.mapping.symbology.SimpleFillSymbolStyle
import com.arcgismaps.mapping.symbology.SimpleRenderer
import com.arcgismaps.geometry.Point
import com.arcgismaps.geometry.SpatialReference
import com.esri.arcgismaps.sample.applysymbologytoshapefile.R
import kotlinx.coroutines.launch
import java.io.File
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel

class ApplySymbologyToShapefileViewModel(application: Application) : AndroidViewModel(application) {
    val provisionPath =
        application.getExternalFilesDir(null)?.path + File.separator + application.getString(R.string.apply_symbology_to_shapefile_app_name)

    // Define renderer: red outline with yellow fill for all features
    private val outlineSymbol = SimpleLineSymbol(
        style = SimpleLineSymbolStyle.Solid,
        color = Color.red,
        width = 1.0f
    )
    private val fillSymbol = SimpleFillSymbol(
        style = SimpleFillSymbolStyle.Solid,
        color = Color.yellow,
        outline = outlineSymbol
    )

    // Initialize the map with a topographic basemap, an initial viewpoint, and the shapefile layer
    val arcGISMap = ArcGISMap(BasemapStyle.ArcGISTopographic).apply {
        val center = Point(
            x = -11662054.0,
            y = 4818336.0,
            spatialReference = SpatialReference.webMercator()
        )
        initialViewpoint = Viewpoint(center, 200000.0)
    }

    // Create a message dialog view model to surface errors
    val messageDialogVM = MessageDialogViewModel()

    init {
        val shapeFile = File(provisionPath, "Subdivisions.shp")
        if (!shapeFile.exists()) {
            messageDialogVM.showMessageDialog(
                "Shapefile not found",
                "Expected .shp file at ${shapeFile.path}"
            )
        } else {
            // Create shapefile table using local file, and create its layer
            val shapefileTable = ShapefileFeatureTable(
                shapeFile.path
            )
            val featureLayer = FeatureLayer.createWithFeatureTable(shapefileTable).apply {
                // Apply the renderer to the layer
                renderer = SimpleRenderer(fillSymbol)
            }
            // Add the shapefile layer to the map and attempt to load the map
            arcGISMap.operationalLayers.add(featureLayer)
            // Load the configured ArcGIS Map
            viewModelScope.launch {
                arcGISMap.load().onFailure { error ->
                    messageDialogVM.showMessageDialog(error)
                }
            }
        }
    }
}

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