Filter features with TimeSlider component

This sample demonstrates how to filter temporal data in a GeoJSONLayer using a TimeSlider component. This can be done by creating a new FeatureFilter and updating the filter's timeExtent property by watching the changes to the TimeSlider's timeExtent property.

When the GeoJSONLayer is initialized, the timeInfo property for the layer is specified as shown below:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
 const layer = new GeoJSONLayer({
  ...
  // specify timeInfo for the layer
  timeInfo: {
    startField: "time", // name of the date field
    interval: { // specify time interval for
      unit: "days",
      value: 1
    }
  }
  ...
 });

The TimeSlider component is added to the app without being associated with arcgis-map component as shown below. This will allow you to apply a custom logic whenever the TimeSlider's timeExtent property changes. This approach is useful if your layer has a date field but does not have time enabled. You can also use this approach if you want to have a complete control over the logic whenever the timeSlider's timeExtent updates.

Use dark colors for code blocksCopy
1
2
3
4
5
<!-- add time slider component outside of the map without a reference-element -->
<arcgis-map basemap="dark-gray-vector" zoom="13" center="-117.512764, 34.04355">
...
</arcgis-map>
<arcgis-time-slider mode="time-window" play-rate="50"></arcgis-time-slider>

Lastly, the application listens to the arcgisPropertyChange event on the time slider component. This event tracks property changes within the component, providing insights into any modifications to the time slider's time extent. In this example, the application updates the layer's feature effect to display earthquakes recorded within the current time extent. Additionally, it performs a statistical query on the earthquakes from that specific day after applying the feature effect.

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
          // listen to time slider component's arcgisPropertyChange event. The event's payload contains
          // info about the time slider's current time extent change.
          // Update the earthquakes layer and its layer view based on the time slider's current time extent.
          timeSlider.addEventListener("arcgisPropertyChange", async (event) => {
            try {
              // Only show earthquakes up until the end of timeSlider's current time extent.
              const date = new Date(timeSlider.timeExtent.end).toISOString().replace("T", " ").replace("Z", "");
              layer.definitionExpression = `time <= Timestamp '${date}'`;

              // Gray out earthquakes that happened before the time slider's current timeExtent.
              layerView.featureEffect = {
                filter: {
                  timeExtent: timeSlider.timeExtent,
                  geometry: arcgisMap.extent
                },
                excludedEffect: "grayscale(20%) opacity(12%)"
              };

              // Run statistics on earthquakes within the current time extent.
              const statQuery = layerView.featureEffect.filter.createQuery();
              statQuery.outStatistics = [magMax, magAvg, magMin, tremorCount, avgDepth];

              const result = await layer.queryFeatures(statQuery);
              statsDiv.innerHTML = "";

              if (result.error) {
                console.error(result.error);
                return;
              }

              // results returned from the query and populate the statsDiv with the results.
              if (result.features.length >= 1) {
                const attributes = result.features[0].attributes;

                // Get statistics fields and their values from the query results.
                // htmls is an array of strings that contain the statistics fields and their values.
                const htmls = Object.keys(statsFields).map(name => {
                  if (attributes[name] != null) {
                    return `<br/>${statsFields[name]}: <b><span>${attributes[name].toFixed(2)}</span></b>`;
                  }
                  return '';
                }).filter(html => html !== '');

                // Display the number of earthquakes that occurred within the current time extent.
                const yearHtml = `
                  <span>${result.features[0].attributes["tremor_count"]}</span> earthquakes were recorded between
                  ${timeSlider.timeExtent.start.toLocaleDateString()} -
                  ${timeSlider.timeExtent.end.toLocaleDateString()}.<br/>
                `;

                statsDiv.innerHTML = htmls.length ? yearHtml + htmls.join('') : yearHtml;
              }
            } catch (error) {
              console.error(error);
            }
          });

How it works

The app shows USGS earthquakes recorded between 5/25/2019 - 6/11/2019. The view's extent is set to Pomona, CA area to show earthquakes recorded in this region.

To start visualizing recorded earthquakes in this region you can do one of the following:

  • Hit play button to automatically update the time visualization.
  • Hit next or previous buttons to step through one day at a time.
  • Drag the thumbs or segment to jump through days.

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