Apply effects to features

Explore in the sandboxView live

This sample demonstrates how you can use spatial relationships to discover how features are spatially related to each other. It sets a featureEffect on layerViews to show the features meet the spatial filter while graying out the features that do not meet the spatial filter. This can be done by creating a new FeatureEffect and specifying its filter and excludedEffect properties. The featureEffect object can then be applied to the layer view's featureEffect property.

How it works

Once the application loads, user can select:

  • Layer - to set a spatial filter on
  • Predefined geometry - to see how features from the layer are spatially related to this geometry
  • Spatial relationship - to specify type of spatial relationship you want to see between the geometries
  • Distance - to create a buffer around the predefined geometry and use the buffer to do spatial filter
  • Unit - specifies the distance unit to apply to the buffer

The layer will be updated as a user makes selections to show features that are included in the spatial filter, while dimming out the features that are excluded from the spatial filter.

Use dark colors for code blocks
                                                                                                                                                                                                                                                                                                                                                                                                                      
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
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport"
      content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <title>Apply effects to features | Sample | ArcGIS API for JavaScript 4.22</title>

    <link rel="stylesheet" href="https://js.arcgis.com/4.22/esri/themes/light/main.css" />
    <script src="https://js.arcgis.com/4.22/"></script>

    <style>
      html,
      body,
      #viewDiv {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
      #infoDiv {
        background-color: white;
        padding: 10px;
        width: 260px;
        margin: 5px;
        position: absolute;
        bottom: 15px;
        right: 10px;
        font-size: 14px;
        display: none;
      .geometry-options {
        display: flex;
        flex-direction: row;
      .geometry-button,
      .layer-button {
        flex: 1;
        border-style: solid;
        border-width: 1px;
        border-image: none;
      .geometry-button-selected {
        background: #4c4c4c;
        color: #fff;
      .options {
        max-width: 260px;
        width: 100%;
        height: 25px;
      #distanceNum {
        width: 100%;
        height: 60px;
    </style>
    <script>
      require([
        "esri/WebMap",
        "esri/layers/GraphicsLayer",
        "esri/views/MapView",
        "esri/Graphic",
        "esri/core/watchUtils",
        "esri/geometry/geometryEngine",
        "esri/widgets/Slider"
      ], (WebMap, GraphicsLayer, MapView, Graphic, watchUtils, geometryEngine, Slider) => {
        let bufferGraphic, featureLayerView;
        let featureFilter = {};
        let layerViews = {};
        let filterGeometries = {};
        //FeatureFilter variables
        let filterGeometry = null;
        let geometryRel = "intersects";
        let distance = 0;
        let unit = "meters";
        const map = new WebMap({
          portalItem: {
            id: "971eae060595416283eaac4ad54cbbda"
        const bufferGeometriesLayer = new GraphicsLayer();
        map.load().then(() => {
          // add the graphics layer to the top once webmap loads
          // loop through webmap's operational layers
          map.layers.forEach((layer, index) => {
            // loop through all layerviews, add them to global variable
            // so that they can be accessed later for filtering
            view.whenLayerView(layer).then((layerView) => {
              if (layer.type === "feature") {
                let type = layer.geometryType;
                if (layerView.layer.geometryType === "point") {
                  // set the point layer view as the active layer view
        let view = new MapView({
          map: map,
          container: "viewDiv",
          padding: { right: 260 }
        // geometry filter distance UI components
        const distanceUnit = document.getElementById("distance-select");
        const spatialRelType = document.getElementById("relationship-select");
        const distanceNum = new Slider({
          container: "distanceNum",
          min: 0,
          max: 1000,
          values: [0],
          steps: 1,
          visibleElements: {
            rangeLabels: true,
            labels: true
        // listen to change and input events on UI components
        distanceNum.on("thumb-drag", distanceVariablesChanged);
        // get user entered values from distance related options
        function distanceVariablesChanged() {
          distance = distanceNum.values[0];
        // update the buffer graphic if user is filtering by distance
        function updateBuffer() {
          if (distance > 0 && filterGeometry) {
            const newBufferGeometry = geometryEngine.geodesicBuffer(filterGeometry, distance, unit);
            bufferGeometriesLayer.graphics.getItemAt(0).geometry = newBufferGeometry;
          } else {
            bufferGraphic.geometry = null;
        // set the geometry filter on the visible FeatureLayerView
        function updateFilter() {
          featureFilter = {
            // autocasts to FeatureFilter
            geometry: filterGeometry,
            spatialRelationship: geometryRel,
            distance: distance,
            units: unit
          };
          // set effect on excluded features
          // make them gray and transparent
          if (featureLayerView) {
            featureLayerView.featureEffect = {
              filter: featureFilter,
              excludedEffect: "grayscale(100%) opacity(30%)"
            }
          }
        }
        // click events for the layer type buttons
        document.getElementById("point-layer-button").onclick = layersChangedClickHandler;
        document.getElementById("line-layer-button").onclick = layersChangedClickHandler;
        document.getElementById("polygon-layer-button").onclick = layersChangedClickHandler;
        // Make the selected layerview visible while setting the other layerviews invisible
        function layersChangedClickHandler(event) {
          for (let key in layerViews) {
            layerViews[key].visible = false;
          const geometryType = event.target.value;
          let layerView = layerViews[geometryType];
          layerView.visible = true;
          setActiveButton(this);
        // geometry buttons - use the selected geometry to set effect
        document.getElementById("point-geometry-button").onclick = geometryButtonsClickHandler;
        document.getElementById("line-geometry-button").onclick = geometryButtonsClickHandler;
        document.getElementById("polygon-geometry-button").onclick = geometryButtonsClickHandler;
        function geometryButtonsClickHandler(event) {
          const geometryType = event.target.value;
          for (let key in filterGeometries) {
            filterGeometries[key].visible = false;
          const filterGraphic = filterGeometries[geometryType];
          filterGraphic.visible = true;
          setActiveButton(this);
        document.getElementById("clearFilter").onclick = () => {
          filterGeometry = null;
          bufferGraphic.geometry = null;
          for (let key in filterGeometries) {
            filterGeometries[key].visible = false;
        function setActiveButton(selectedButton) {
          // focus the view to activate keyboard shortcuts for sketching
          const elements = document.getElementsByClassName("geometry-button-selected");
          if (selectedButton) {
            for (let i = 0; i < elements.length; i++) {
              if (elements[i].classList.contains("layer-button") && selectedButton.classList.contains("layer-button")) {
                elements[i].classList.remove("geometry-button-selected");
              } else if (
                elements[i].classList.contains("geometry-button") &&
                selectedButton.classList.contains("geometry-button")
                elements[i].classList.remove("geometry-button-selected");
              selectedButton.classList.add("geometry-button-selected");
          } else if (!selectedButton) {
            for (let i = 0; i < elements.length; i++) {
              if (elements[i].classList.contains("geometry-button")) {
                elements[i].classList.remove("geometry-button-selected");
        // add predefined point, line and polygon features
        view.when(() => {
          const polygon = {
            type: "polygon",
            rings: [
              [-8369152.108088223, 4858625.975183949],
              [-8364871.261276581, 4858713.161169337],
              [-8365068.4747812, 4855823.856429268],
              [-8369472.561371844, 4856045.031150761],
              [-8369152.108088223, 4858625.975183949]
            spatialReference: view.spatialReference
          const polygonGraphic = new Graphic({
            geometry: polygon,
            symbol: {
              type: "simple-fill", // autocasts as new SimpleFillSymbol()
              color: [51, 51, 204, 0.4],
              style: "solid",
              outline: {
                color: "white",
                width: 1
            visible: false
          const line = {
            type: "polyline",
            paths: [
            spatialReference: view.spatialReference
          const lineGraphic = new Graphic({
            geometry: line,
            symbol: {
              type: "simple-line",
              color: [51, 51, 204, 0.5],
              width: "4px"
            visible: false
          const point = {
            type: "point",
            x: polygonGraphic.geometry.centroid.x,
            y: polygonGraphic.geometry.centroid.y,
            spatialReference: view.spatialReference
          const pointGraphic = new Graphic({
            geometry: point,
            symbol: {
              type: "text",
              color: [51, 51, 204, 0.9],
              text: "\ue61d",
              font: {
                size: 24,
                family: "CalciteWebCoreIcons"
            visible: false
          bufferGraphic = new Graphic({
            symbol: {
              type: "simple-fill",
              color: [151, 151, 204, 0.5],
              style: "solid",
              outline: {
                color: "white",
                width: 1
            visible: true
          document.getElementById("infoDiv").style.display = "block";
    </script>
  </head>

  <body>
    <div id="viewDiv"></div>
    <div id="infoDiv" class="esri-widget">
      <b>Explore spatial relationships</b><br/><br/>
      <label for="layers">Select a layer:</label>
      <div class="geometry-options" id="layers">
        <button
          class="esri-widget--button esri-icon-map-pin layer-button
          geometry-button-selected"
          id="point-layer-button"
          value="point"
          title="Select a point layer to see how it is spatially related to one of the predefined geometries"></button>
        <button
          class="esri-widget--button esri-icon-polyline layer-button"
          id="line-layer-button"
          value="polyline"
          title="Select a line layer to see how it is spatially related to one of the predefined geometries"></button>
        <button
          class="esri-widget--button esri-icon-polygon layer-button"
          id="polygon-layer-button"
          value="polygon"
          title="Select a polygon layer to see how it is spatially related to one of the predefined geometries"></button>
      </div>
      <br />Select a predefined geometry:
      <div class="geometry-options">
        <button
          class="esri-widget--button esri-icon-map-pin geometry-button"
          id="point-geometry-button"
          value="point"
          title="Filter by point"></button>
        <button
          class="esri-widget--button esri-icon-polyline geometry-button"
          id="line-geometry-button"
          value="polyline"
          title="Filter by line"></button>
        <button
          class="esri-widget--button esri-icon-polygon geometry-button"
          id="polygon-geometry-button"
          value="polygon"
          title="Filter by polygon"></button>
      </div>
      <br />
      <label for="relationship-select">Spatial relationship:</label>
      <select id="relationship-select" class="options">
        <option value="intersects" selected>intersects</option>
        <option value="contains">contains</option>
        <option value="crosses">crosses</option>
        <option value="envelope-intersects">envelope-intersects</option>
        <option value="overlaps">overlaps</option>
        <option value="touches">touches</option>
        <option value="within">within</option>
        <option value="disjoint">disjoint</option> </select><br /><br />
      <div class="tooltip">
        <label for="distanceNum">Change distance:</label>
        <div id="distanceNum"></div>
      </div>
      <label for="distance-select">Distance unit:</label>
      <select id="distance-select" class="options">
        <option value="meters">meters</option>
        <option value="kilometers">kilometers</option>
        <option value="feet">feet</option>
        <option value="miles">miles</option>
        <option value="nautical-miles">nautical-miles</option> </select><br /><br
        /><br />
      <button class="esri-button" id="clearFilter" type="button">Clear all
        filter</button>
    </div>
  </body>
</html>

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