Skip to content
View on GitHubSample viewer app

Apply a unique value with alternate symbols at different scales.

Display alternate symbols at different scales sample

Use case

When a layer is symbolized with unique value symbology, you can specify the visible scale range for each unique value. This is an effective strategy to limit the amount of detailed data at smaller scales without having to make multiple versions of the layer, each with a unique definition query.

Once scale ranges are applied to unique values, you can further refine the appearance of features within those scale ranges by establishing alternate symbols to different parts of the symbol class scale range.

How to use the sample

Zoom in and out of the map to see alternate symbols at each scale. The symbology changes according to the following scale ranges: 0-5,000, 5,000-10,000, 10,000-20,000. To go back to the initial viewpoint, tap "Reset Viewpoint".

How it works

  1. Create a FeatureLayer using the service URL and add it to the map's list of operational layers.
  2. Create two alternate symbols (a blue square and a yellow diamond) to be used as alternate symbols. To create an alternate symbol:
    1. Create a symbol using SimpleMarkerSymbol.
    2. Convert the simple marker symbol to an MultilayerSymbol using SimpleMarkerSymbol.toMultilayerSymbol().
    3. Set the multilayer symbol's referenceProperties to the valid scale ranges with the blue square and yellow diamond.
  3. Create a third multilayer symbol to be used to create a UniqueValue class.
  4. Create a unique value using the red triangle from step 3 and the list of alternate symbols from step 2.
  5. Create a UniqueValueRenderer and add the unique value from step 4 to it.
  6. Create a purple diamond simple marker and convert it to a multilayer symbol to be used as the default symbol.
  7. Set the unique value renderer's defaultSymbol property to the purple diamond from step 6.
  8. Set the unique value renderer's fieldNames property to "req_type".
  9. Apply this unique value renderer to the renderer on feature layer.

Relevant API

  • MultilayerSymbol
  • SimpleMarkerSymbol
  • SymbolReferenceProperties
  • UniqueValue
  • UniqueValueRenderer

About the data

The San Francisco 311 incidents layer in this sample displays point features related to crime incidents such as graffiti and tree damage that have been reported by city residents.

Tags

alternate symbols, multilayer symbol, scale based rendering, simple marker symbol, symbol reference properties, symbology, unique value, unique value renderer

Sample Code

DisplayAlternateSymbolsAtDifferentScalesViewModel.ktDisplayAlternateSymbolsAtDifferentScalesViewModel.ktMainActivity.ktDisplayAlternateSymbolsAtDifferentScalesScreen.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
/* 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.displayalternatesymbolsatdifferentscales.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.Color
import com.arcgismaps.data.ServiceFeatureTable
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.FeatureLayer
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbol
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbolStyle
import com.arcgismaps.mapping.symbology.SymbolReferenceProperties
import com.arcgismaps.mapping.symbology.UniqueValue
import com.arcgismaps.mapping.symbology.UniqueValueRenderer
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

/**
 * ViewModel for the sample demonstrating alternate symbols at different scales.
 */
class DisplayAlternateSymbolsAtDifferentScalesViewModel(app: Application) : AndroidViewModel(app) {

    // Feature layer created from the service, using URL for the SF311 incidents feature layer
    private val featureLayer = FeatureLayer.createWithFeatureTable(
        featureTable = ServiceFeatureTable(
            uri = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/0"
        )
    )

    // Map initialized to the a viewpoint and feature layer.
    val arcGISMap: ArcGISMap = ArcGISMap(BasemapStyle.ArcGISTopographic).apply {
        val center = Point(
            x = -13631200.0,
            y = 4546830.0,
            spatialReference = com.arcgismaps.geometry.SpatialReference.webMercator()
        )
        initialViewpoint = Viewpoint(center = center, scale = 7500.0)
        // Add the incidents feature layer
        operationalLayers += featureLayer
    }

    // MapViewProxy to perform viewpoint changes
    val mapViewProxy = MapViewProxy()

    // Expose the current MapView scale
    private val _currentScale = MutableStateFlow(arcGISMap.initialViewpoint?.targetScale)
    val currentScale = _currentScale.asStateFlow()

    // Message dialog helper for errors
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            // Load the map with the feature layer
            arcGISMap.load().onFailure { return@launch messageDialogVM.showMessageDialog(it) }
            // Configure the unique value renderer
            configureUniqueValueRenderer()
        }
    }

    /**
     * Build the multilayer symbols with reference scale ranges and apply a [UniqueValueRenderer]
     * to the feature layer. Alternate symbols are assigned to scale ranges.
     */
    private fun configureUniqueValueRenderer() {
        // Red triangle used for the base symbol (0 - 5,000)
        val redTriangle = SimpleMarkerSymbol(
            style = SimpleMarkerSymbolStyle.Triangle,
            color = Color.red,
            size = 30f
        ).toMultilayerSymbol().apply {
            referenceProperties = SymbolReferenceProperties(
                minScale = 5_000.0,
                maxScale = 0.0
            )
        }

        // Blue square alternate symbol (5,000 - 10,000)
        val blueSquare = SimpleMarkerSymbol(
            style = SimpleMarkerSymbolStyle.Square,
            color = Color.blue,
            size = 30f
        ).toMultilayerSymbol().apply {
            referenceProperties = SymbolReferenceProperties(
                minScale = 10_000.0,
                maxScale = 5_000.0
            )
        }

        // Yellow diamond alternate symbol (10,000 - 20,000)
        val yellowDiamond = SimpleMarkerSymbol(
            style = SimpleMarkerSymbolStyle.Diamond,
            color = Color.yellow,
            size = 30f
        ).toMultilayerSymbol().apply {
            referenceProperties = SymbolReferenceProperties(
                minScale = 20_000.0,
                maxScale = 10_000.0
            )
        }

        // Unique value using the red triangle and the alternate symbols
        val uniqueValue = UniqueValue(
            description = "unique values based on request type",
            label = "unique value",
            symbol = redTriangle,
            values = listOf("Damaged Property"),
            alternateSymbols = listOf(blueSquare, yellowDiamond)
        )

        // Default purple diamond for other values
        val purpleDiamond = SimpleMarkerSymbol(
            style = SimpleMarkerSymbolStyle.Diamond,
            color = Color.fromRgba(r = 128, g = 0, b = 128),
            size = 15f
        ).toMultilayerSymbol()

        val uniqueValueRenderer = UniqueValueRenderer(
            fieldNames = listOf("req_type"),
            uniqueValues = listOf(uniqueValue),
            defaultSymbol = purpleDiamond
        )

        // Set the renderer to symbolize geo-elements with a distinct symbol.
        featureLayer.renderer = uniqueValueRenderer
    }

    /**
     * Called from the MapView composable when the viewpoint changes.
     */
    fun updateScale(newScale: Double?) {
        _currentScale.value = newScale
    }

    /**
     * Reset the viewpoint to the map's initial viewpoint using MapViewProxy.
     */
    fun resetViewpoint() {
        val initialViewpoint = arcGISMap.initialViewpoint ?: return
        viewModelScope.launch {
            mapViewProxy.setViewpointAnimated(initialViewpoint)
        }
    }
}

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