Add graphics renderer

View on GitHub
Sample viewer app

A renderer allows you to change the style of all graphics in a graphics overlay by referencing a single symbol style. A renderer will only effect graphics that do not specify their own symbol style.

Image of add graphics renderer

Use case

A renderer allows you to change the style of all graphics in an overlay by only changing one copy of the symbol. For example, a user may wish to display a number of graphics on a map of a parkland which represents trees, all sharing a common symbol.

How to use the sample

Run the sample and view graphics for points, lines, and polygons, which are stylized using renderers.

How it works

  1. Create a GraphicsOverlay and add it to the MapView.
  2. Create a Graphic, specifying only a Geometry.
  3. Create a single Symbol such as a SimpleMarkerSymbol.
  4. Create a renderer with the Symbol such as a SimpleRenderer(symbol).
  5. Set the renderer on the GraphicsOverlay with graphicsOverlay.renderer = renderer.

Relevant API

  • CubicBezierSegment
  • EllipticArcSegment
  • GeodesicEllipseParameters
  • Geometry
  • GeometryEngine
  • Graphic
  • GraphicsOverlay
  • MutablePart
  • PolygonBuilder
  • PolylineBuilder
  • SimpleFillSymbol
  • SimpleLineSymbol
  • SimpleMarkerSymbol
  • SimpleRenderer

Additional information

To set unique symbols across a number of graphics (e.g. showing graphics of individual landmarks) see "Add graphics with symbols" sample.

Tags

arc, bezier, curve, display, ellipse, graphics, marker, overlay, renderer, segment, symbol, true curve

Sample Code

MainActivity.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
/* Copyright 2020 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.arcgisruntime.sample.addgraphicsrenderer

import android.graphics.Color
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
import com.esri.arcgisruntime.geometry.GeodesicEllipseParameters
import com.esri.arcgisruntime.geometry.GeometryEngine
import com.esri.arcgisruntime.geometry.GeometryType
import com.esri.arcgisruntime.geometry.Geometry
import com.esri.arcgisruntime.geometry.EllipticArcSegment
import com.esri.arcgisruntime.geometry.CubicBezierSegment
import com.esri.arcgisruntime.geometry.Part
import com.esri.arcgisruntime.geometry.Polygon
import com.esri.arcgisruntime.geometry.Point
import com.esri.arcgisruntime.geometry.SpatialReferences
import com.esri.arcgisruntime.geometry.AngularUnit
import com.esri.arcgisruntime.geometry.AngularUnitId
import com.esri.arcgisruntime.geometry.LinearUnit
import com.esri.arcgisruntime.geometry.LinearUnitId
import com.esri.arcgisruntime.geometry.PolylineBuilder
import com.esri.arcgisruntime.geometry.PolygonBuilder
import com.esri.arcgisruntime.mapping.ArcGISMap
import com.esri.arcgisruntime.mapping.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
import com.esri.arcgisruntime.mapping.view.Graphic
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay
import com.esri.arcgisruntime.mapping.view.MapView
import com.esri.arcgisruntime.sample.addgraphicsrenderer.databinding.ActivityMainBinding
import com.esri.arcgisruntime.symbology.SimpleFillSymbol
import com.esri.arcgisruntime.symbology.SimpleLineSymbol
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol
import com.esri.arcgisruntime.symbology.SimpleRenderer

class MainActivity : AppCompatActivity() {

    private val activityMainBinding by lazy {
        ActivityMainBinding.inflate(layoutInflater)
    }

    private val mapView: MapView by lazy {
        activityMainBinding.mapView
    }

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

        // authentication with an API key or named user is required to access basemaps and other
        // location services
        ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)

        // create a map with a topographic basemap
        val map = ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC)

        // set the map to be displayed in this view
        mapView.map = map
        mapView.setViewpoint(Viewpoint(15.169193, 16.333479, 100000000.0))

        // add graphics overlays
        mapView.graphicsOverlays.addAll(
            arrayOf(
                renderedPointGraphicsOverlay(),
                renderedLineGraphicsOverlay(),
                renderedPolygonGraphicsOverlay(),
                renderedCurvedPolygonGraphicsOverlay(),
                renderedEllipseGraphicsOverlay()
            )
        )
    }

    /**
     * Create an ellipse, its graphic, a graphics overlay for it, and add it to the map view.
     * */
    private fun renderedEllipseGraphicsOverlay(): GraphicsOverlay {
        // create and set all the parameters so that the ellipse has a major axis of 400 kilometres,
        // a minor axis of 200 kilometres and is rotated at an angle of -45 degrees
        val parameters = GeodesicEllipseParameters()
        parameters.apply {
            center = Point(40e5, 23e5, SpatialReferences.getWebMercator())
            geometryType = GeometryType.POLYGON
            semiAxis1Length = 200.0
            semiAxis2Length = 400.0
            axisDirection = -45.0
            setMaxPointCount(100)
            angularUnit = AngularUnit(AngularUnitId.DEGREES)
            linearUnit = LinearUnit(LinearUnitId.KILOMETERS)
            maxSegmentLength = 20.0
        }
        // define the ellipse parameters to a polygon geometry
        val polygon = GeometryEngine.ellipseGeodesic(parameters)
        // create an ellipse graphic overlay using the defined polygon
        val ellipseGraphicOverlay = GraphicsOverlay()
        val ellipseSymbol = SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, Color.MAGENTA, null)
        ellipseGraphicOverlay.renderer = SimpleRenderer(ellipseSymbol)
        ellipseGraphicOverlay.graphics.add(Graphic(polygon))
        return ellipseGraphicOverlay
    }

    /**
     * Create a point, its graphic, a graphics overlay for it, and add it to the map view.
     * */
    private fun renderedPointGraphicsOverlay(): GraphicsOverlay {
        // create point
        val pointGeometry = Point(40e5, 40e5, SpatialReferences.getWebMercator())
        // create graphic for point
        val pointGraphic = Graphic(pointGeometry)
        // red diamond point symbol
        val pointSymbol =
            SimpleMarkerSymbol(SimpleMarkerSymbol.Style.DIAMOND, Color.RED, 10f)
        // create simple renderer
        val pointRenderer = SimpleRenderer(pointSymbol)

        // create a new graphics overlay with these settings and add it to the map view
        return GraphicsOverlay().apply {
            // add graphic to overlay
            graphics.add(pointGraphic)
            // set the renderer on the graphics overlay to the new renderer
            renderer = pointRenderer
        }
    }

    /**
     * Create a polyline, its graphic, a graphics overlay for it, and add it to the map view.
     * */
    private fun renderedLineGraphicsOverlay(): GraphicsOverlay {
        // create line
        val lineGeometry = PolylineBuilder(SpatialReferences.getWebMercator()).apply {
            addPoint(-10e5, 40e5)
            addPoint(20e5, 50e5)
        }
        // create graphic for polyline
        val lineGraphic = Graphic(lineGeometry.toGeometry())
        // solid blue line symbol
        val lineSymbol =
            SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLUE, 5f)
        // create simple renderer
        val lineRenderer = SimpleRenderer(lineSymbol)

        // create graphic overlay for polyline and add it to the map view
        return GraphicsOverlay().apply {
            // add graphic to overlay
            graphics.add(lineGraphic)
            // set the renderer on the graphics overlay to the new renderer
            renderer = lineRenderer
        }
    }

    /**
     * Create a polygon, its graphic, a graphics overlay for it, and add it to the map view.
     * */
    private fun renderedPolygonGraphicsOverlay(): GraphicsOverlay {
        // create polygon
        val polygonGeometry = PolygonBuilder(SpatialReferences.getWebMercator()).apply {
            addPoint(-20e5, 20e5)
            addPoint(20e5, 20e5)
            addPoint(20e5, -20e5)
            addPoint(-20e5, -20e5)
        }
        // create graphic for polygon
        val polygonGraphic = Graphic(polygonGeometry.toGeometry())
        // solid yellow polygon symbol
        val polygonSymbol =
            SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, Color.YELLOW, null)
        // create simple renderer
        val polygonRenderer = SimpleRenderer(polygonSymbol)

        // create graphic overlay for polygon and add it to the map view
        return GraphicsOverlay().apply {
            // add graphic to overlay
            graphics.add(polygonGraphic)
            // set the renderer on the graphics overlay to the new renderer
            renderer = polygonRenderer
        }
    }

    /**
     * Create a polygon, its graphic, a graphics overlay for it, and add it to the map view.
     * */
    private fun renderedCurvedPolygonGraphicsOverlay(): GraphicsOverlay {
        // create a point for the center of the geometry
        val originPoint = Point(40e5, 5e5, SpatialReferences.getWebMercator())
        // create polygon
        val curvedPolygonGeometry = makeHeartGeometry(originPoint, 10e5)
        // create graphic for polygon
        val polygonGraphic = Graphic(curvedPolygonGeometry)
        // create a simple fill symbol with outline
        val curvedLineSymbol = SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLACK, 1f)
        val curvedFillSymbol =
            SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, Color.RED, curvedLineSymbol)
        // create simple renderer
        val polygonRenderer = SimpleRenderer(curvedFillSymbol)

        // create graphic overlay for polygon and add it to the map view
        return GraphicsOverlay().apply {
            // add graphic to overlay
            graphics.add(polygonGraphic)
            // set the renderer on the graphics overlay to the new renderer
            renderer = polygonRenderer
        }
    }

    /**
     * Create a heart-shape geometry with Bezier and elliptic arc segments from a given [center]
     * point and [sideLength].
     */
    private fun makeHeartGeometry(center: Point, sideLength: Double): Geometry {
        val spatialReference = center.spatialReference
        // the x and y coordinates to simplify the calculation
        val minX = center.x - 0.5 * sideLength
        val minY = center.y - 0.5 * sideLength
        // the radius of the arcs
        val arcRadius = sideLength * 0.25

        // bottom left curve
        val leftCurveStart = Point(center.x, minY, spatialReference)
        val leftCurveEnd = Point(minX, minY + 0.75 * sideLength, spatialReference)
        val leftControlPoint1 = Point(center.x, minY + 0.25 * sideLength, spatialReference)
        val leftControlPoint2 = Point(minX, center.y, spatialReference)
        val leftCurve = CubicBezierSegment(
            leftCurveStart,
            leftControlPoint1,
            leftControlPoint2,
            leftCurveEnd,
            spatialReference
        )

        // top left arc
        val leftArcCenter =
            Point(minX + 0.25 * sideLength, minY + 0.75 * sideLength, spatialReference)
        val leftArc = EllipticArcSegment.createCircularEllipticArc(
            leftArcCenter,
            arcRadius,
            Math.PI,
            -Math.PI,
            spatialReference
        )

        // top right arc
        val rightArcCenter =
            Point(minX + 0.75 * sideLength, minY + 0.75 * sideLength, spatialReference)
        val rightArc = EllipticArcSegment.createCircularEllipticArc(
            rightArcCenter,
            arcRadius,
            Math.PI,
            -Math.PI,
            spatialReference
        )

        // bottom right curve
        val rightCurveStart = Point(minX + sideLength, minY + 0.75 * sideLength, spatialReference)
        val rightCurveEnd = leftCurveStart
        val rightControlPoint1 = Point(minX + sideLength, center.y, spatialReference)
        val rightControlPoint2 = leftControlPoint1
        val rightCurve = CubicBezierSegment(
            rightCurveStart,
            rightControlPoint1,
            rightControlPoint2,
            rightCurveEnd,
            spatialReference
        )

        val heart = Part(spatialReference).apply {
            add(leftCurve)
            add(leftArc)
            add(rightArc)
            add(rightCurve)
        }
        return Polygon(heart, spatialReference)
    }

    override fun onPause() {
        mapView.pause()
        super.onPause()
    }

    override fun onResume() {
        super.onResume()
        mapView.resume()
    }

    override fun onDestroy() {
        mapView.dispose()
        super.onDestroy()
    }
}

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