-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
1021 lines (909 loc) · 56.2 KB
/
index.html
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en-GB">
<head>
<title>Trafford Data Lab: Choroplether</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover"/>
<meta charset="UTF-8"/>
<meta name="keywords" content="trafford, vega-lite, choropleth, choropleths, map"/>
<meta name="description" content="Trafford Data Lab web application allowing the quick creation of choropleth map visualisations based on Vega-Lite."/>
<link rel="stylesheet" href="css/base.css"/>
<link rel="stylesheet" href="css/main.css"/>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans|Roboto"/>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.10/css/all.css" integrity="sha384-+d0P83n9kaQMCwj8F4RJB66tzIwOKmrdb46+porD/OvrJ+37WqIM7UoBtwHO6Nlg" crossorigin="anonymous">
<style>
fieldset
{
border-radius: 10px;
border: 1px solid #ccc;
box-shadow: 5px 5px 10px #f0f0f0;
margin-bottom: 20px;
font-size: 0.85em;
padding-top: 0.75em;
}
fieldset textarea
{
width: 100%;
height: 6em;
min-height: 6em;
resize: vertical;
}
select
{
margin-top: 1em;
}
legend
{
background-color: #5d77a3;
border-radius: 10px;
padding: 0 8px;
}
legend button
{
background-color: transparent;
color: #fff;
border: 0;
padding: 0;
font-size: 14px;
text-transform: uppercase;
}
legend:hover, legend button:hover
{
cursor: pointer;
}
legend .fa
{
margin-left: 0.5em; /* move the expand/minimise icon away from legend name in the fieldsets */
}
fieldset ul
{
padding-left: 1em; /* don't indent the list past the left margin of the other content */
}
.showContentMsg
{
color: #707070;
}
.longInputBox
{
width: 50%;
}
.longInputBoxLabel
{
display: inline-block;
width: 7em;
}
#toolsPanel
{
max-width: 400px;
float: left;
padding-bottom: 10px;
}
#vegaLiteViz
{
float: right;
}
#updateButton
{
margin-left: 10px;
padding: 6px 12px 6px 6px;
border-radius: 20px;
}
/* This span also has the fa fa-redo-alt classes applied to it */
#updateIcon
{
font-size: 20px;
margin-right: 4px;
}
@media (max-width:1160px)
{
#layoutContainer
{
width: 500px;
margin: auto;
}
#vegaLiteViz
{
float: none;
}
#toolsPanel
{
width: 500px;
max-width: 500px;
}
}
@media (max-width:620px)
{
#layoutContainer, #toolsPanel
{
width: 100%;
max-width: 100%;
}
#vegaLiteViz
{
width: 100%;
max-width: 100%;
overflow-x: scroll;
}
}
/* Overridden styles from base.css */
.labButton
{
font-size: 1em;
margin: 0;
}
/* Font-Awesome overridden styles */
.fa-exclamation-triangle
{
font-size: 300px;
color: #ccc;
display: block;
text-align: center;
}
</style>
</head>
<body>
<div class="container">
<header>
<nav>
<ul id="a11yNav">
<li><a href="#dataToggleButton" class="themeBlockDark">Skip to data section</a></li>
</ul>
<a href="https://www.trafforddatalab.io/index.html" aria-label="Go to the Trafford Data Lab home page"><img src="https://www.trafforddatalab.io/assets/logo/trafforddatalab_logo.svg" alt="Trafford Data Lab" width="93" border="0" class="traffordDataLabLogo"/></a>
</nav>
<h1 id="headerTitle">Choroplether</h1>
</header>
<main id="main">
<p>Choroplether allows the quick creation of <a href="https://www.axismaps.com/guide/univariate/choropleth/" target="_blank">choropleth maps</a> in <a href="https://vega.github.io/vega-lite/" target="_blank">Vega-Lite</a> using your own data. A demonstration showing the <abbr title="Office for National Statistics"><a href="https://www.ons.gov.uk/" target="_blank" aria-label="ONS - Office for National Statistics">ONS</a></abbr> Census 2021 population estimates for local authorities in Greater Manchester has been automatically generated. <a href="documentation.html" target="_blank">The documentation</a> provides further details on using the app, however please note that Choroplether requires a modern browser - it will not work in Internet Explorer.</p>
<p class="contentBlock themeBlockLight smallText">
<span style="font-weight: bold">MAP LABELS:</span> New feature available in the Design section! Find out more in the <a href="documentation.html#design" target="_blank">documentation</a>.
</p><br />
<div id="layoutContainer">
<div id="toolsPanel">
<fieldset>
<legend aria-label="data section, expanded"><button id="dataToggleButton" type="button" onclick="toggleContentSection('data')" aria-label="data section" aria-expanded="true">Data<span id="dataToggleIcon" class="fa fa-minus"></span></button></legend>
<div id="dataShowContent" class="showContentMsg hideContent" aria-label="Expand this section using the button to provide the data">Provide the data...</div>
<div id="dataForm">
<span id="dataInfo">Provide the data in <abbr title="Comma Separated Values"><a href="data_example.csv" target="_blank" aria-label="CSV - Comma Separated Values">CSV</a></abbr> or <abbr title="JavaScript Object Notation"><a href="data_example.json" target="_blank" aria-label="JSON - JavaScript Object Notation">JSON</a></abbr> format,</span> (use the links to download a template example of each file type):
<p>
<button type="button" class="labButton" onclick="document.getElementById('localFileData').click()" aria-describedby="dataInfo">Choose a data file from your device</button> or
</p>
<label for="data" aria-describedby="dataInfo">Enter the data or its <abbr title="Uniform Resource Locator">URL</abbr> into the text box:</label><br />
<textarea id="data" onChange="checkData(this)" aria-label="data text box"></textarea>
</div>
</fieldset>
<fieldset>
<legend aria-label="geography section, collapsed"><button id="geographyToggleButton" type="button" onclick="toggleContentSection('geography')" aria-label="geography section" aria-expanded="false">Geography<span id="geographyToggleIcon" class="fa fa-plus"></span></button></legend>
<div id="geographyShowContent" class="showContentMsg" aria-label="Expand this section using the button to select a geography">Select a geography...</div>
<div id="geographyForm" class="hideContent">
<label for="geographyList">Select a geography</label> matching your data. Choose <span style="font-style: italic;">"other (custom)"</span> for further options:
<br />
<select id="geographyList" onchange="checkGeographyChoice(this.value)">
<optgroup label="Local Authority">
<option value="https://www.trafforddatalab.io/spatial_data/local_authority/2021/gm_local_authority_generalised.geojson" selected="selected">Greater Manchester Authorities (2021)</option>
</optgroup>
<optgroup label="Electoral Ward">
<option value="https://www.trafforddatalab.io/spatial_data/ward/2023/trafford_ward_generalised.geojson">Trafford wards (2023)</option>
<option value="https://www.trafforddatalab.io/spatial_data/ward/2023/gm_ward_generalised.geojson">Greater Manchester wards (2023)</option>
</optgroup>
<optgroup label="Lower layer Super Output Area (LSOA)">
<option value="https://www.trafforddatalab.io/spatial_data/lsoa/2021/trafford_lsoa_generalised.geojson">Trafford LSOAs (2021)</option>
<option value="https://www.trafforddatalab.io/spatial_data/lsoa/2011/trafford_lsoa_generalised.geojson">Trafford LSOAs (2011)</option>
<option value="https://www.trafforddatalab.io/spatial_data/lsoa/2021/gm_lsoa_generalised.geojson">Greater Manchester LSOAs (2021)</option>
<option value="https://www.trafforddatalab.io/spatial_data/lsoa/2011/gm_lsoa_generalised.geojson">Greater Manchester LSOAs (2011)</option>
</optgroup>
<optgroup label="Middle layer Super Output Area (MSOA)">
<option value="https://www.trafforddatalab.io/spatial_data/msoa/2021/trafford_msoa_generalised.geojson">Trafford MSOAs (2021)</option>
<option value="https://www.trafforddatalab.io/spatial_data/msoa/2011/trafford_msoa_generalised.geojson">Trafford MSOAs (2011)</option>
<option value="https://www.trafforddatalab.io/spatial_data/msoa/2021/gm_msoa_generalised.geojson">Greater Manchester MSOAs (2021)</option>
<option value="https://www.trafforddatalab.io/spatial_data/msoa/2011/gm_msoa_generalised.geojson">Greater Manchester MSOAs (2011)</option>
</optgroup>
<optgroup label="Miscellaneous">
<option value="https://www.trafforddatalab.io/spatial_data/council_defined/2023/trafford_localities_generalised_resolution.geojson">Trafford localities (2023)</option>
</optgroup>
<option value="other">Other (custom)</option>
</select>
<div id="geographyCustom" class="hideContent">
<p id="geographyInfo">
Provide the geography in <abbr title="Geospatial data in JavaScript Object Notation"><a href="https://geojson.org/" target="_blank" aria-label="GeoJSON - Geospatial data in JavaScript Object Notation">GeoJSON</a></abbr> format:
</p>
<p>
<button type="button" id="geographyCustomFile" class="labButton" onclick="document.getElementById('localFileGeography').click()" aria-describedby="geographyInfo">Choose a geography file from your device</button> or
</p>
<label for="geography" aria-describedby="geographyInfo">Enter the geography or its <abbr title="Uniform Resource Locator">URL</abbr> into the text box:</label>
<textarea id="geography" onChange="checkGeography(this.value)" aria-label="geography text box"></textarea>
</div>
</div>
</fieldset>
<fieldset>
<legend aria-label="design section, collapsed"><button id="designToggleButton" type="button" onclick="toggleContentSection('design')" aria-label="design section" aria-expanded="false">Design<span id="designToggleIcon" class="fa fa-plus"></span></button></legend>
<div id="designShowContent" class="showContentMsg" aria-label="Expand this section using the button to customise the map">Customise the map...</div>
<div id="designForm" class="hideContent">
Customise the map with titles, choose the palette etc.
<br /><br />
<label for="vizTitle" class="longInputBoxLabel">Map title:</label><input type="text" id="vizTitle" name="vizTitle" class="longInputBox" placeholder="Optional: title for map" onchange="updateTitle(this.value)"/>
<br />
<label for="vizLegendTitle" class="longInputBoxLabel">Legend title:</label><input type="text" id="vizLegendTitle" name="vizLegendTitle" class="longInputBox" placeholder="Optional: title for legend" onchange="updateLegendTitle(this.value)"/>
<br />
<label for="vizAttribution" class="longInputBoxLabel">Attribution:</label><input type="text" id="vizAttribution" name="vizAttribution" class="longInputBox" placeholder="Required for OS & ONS products" onchange="updateAttribution(this.value)"/>
<br /><br />
<span aria-label="Map labels: add or remove labels for the area names and values on the map"><span class="longInputBoxLabel" aria-hidden="true">Map labels:</span><input type="checkbox" id="vizAreaLabels" name="vizAreaLabels" onchange="mapLabels()"/><label for="vizAreaLabels">Area names</label> <input type="checkbox" id="vizValueLabels" name="vizValueLabels" onchange="mapLabels()"/><label for="vizValueLabels">Area values</label></span>
<br /><br />
<label for="paletteList">Select a palette</label>. Choose <span style="font-style: italic;">"other (custom)"</span> for further options:
<br />
<select id="paletteList" onchange="updatePalette(this)">
<optgroup label="Sequential Single-Hue">
<option value="blues">blues</option>
<option value="browns">browns</option>
<option value="greens">greens</option>
<option value="oranges">oranges</option>
<option value="teals">teals</option>
<option value="tealblues" selected="selected">tealblues</option>
<option value="warmgreys">warmgreys</option>
</optgroup>
<optgroup label="Sequential Multi-Hue">
<option value="bluepurple">bluepurple</option>
<option value="goldgreen">goldgreen</option>
<option value="inferno">inferno</option>
<option value="viridis">viridis</option>
<option value="yellowgreenblue">yellowgreenblue</option>
<option value="yelloworangered">yelloworangered</option>
</optgroup>
<option value="other">Other (custom)</option>
</select>
<div id="paletteCustom" class="hideContent">
<p id="paletteInfo">
Enter a valid <a href="https://vega.github.io/vega/docs/schemes/#seq-single-hue" target="_blank">sequential palette scheme name</a>
</p>
<p>
<label for="palette" class="longInputBoxLabel" aria-describedby="paletteInfo">Palette name:</label><input type="text" id="palette" name="palette" class="longInputBox" placeholder="Required: sequential scheme name" onchange="updatePalette(this)"/>
</p>
</div>
<p>
Select the type of scale<span id="intervalsMsg" class="hideContent"> and number of intervals</span> to use.
<br />
<label for="scaleList">Scale:</label>
<select id="scaleList" onchange="updateScale(this.value)">
<option value="linear" selected="selected">Linear</option>
<option value="quantile">Quantile</option>
<option value="quantize">Equal intervals</option>
</select>
<span id="intervalsContainer" class="hideContent">
<label for="intervalsList">Intervals:</label>
<select id="intervalsList" onchange="updateIntervals(this.value)">
<option value="4" selected="selected">4</option>
<option value="5">5</option>
<option value="6">6</option>
<option value="7">7</option>
</select>
</span>
</p>
</div>
</fieldset>
<button id="updateButton" type="button" onclick="createVisualisation()" aria-label="Update the map" class="labButton">
<span id="updateIcon" class="fas fa-redo-alt fa3x" aria-hidden="true"></span>
UPDATE
</button>
</div>
<div id="vegaLiteViz" aria-live="assertive"></div>
</div>
</main>
</div>
<!-- File loading form elements (hidden via CSS) START -->
<div class="hideContent">
<label>Data: <input type="file" id="localFileData" onChange="localFileLoader(this,'data')"/></label>
<label>Geography<input type="file" id="localFileGeography" onChange="localFileLoader(this,'geography')"/></label>
</div>
<!-- File loading elements END -->
<!-- Load script libraries for Vega-Lite -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<!-- Our external file loader -->
<script src="https://www.trafforddatalab.io/assets/javascript/labAjax.js"></script>
<script src="https://www.trafforddatalab.io/assets/javascript/labError.js"></script>
<script>
/*
### Attributions and licences ###
Created: 2019-09-04 by James Austin - Trafford Data Lab
Purpose: Allow users to create Vega-Lite choropleth visualisations easily
Dependencies: Vega-Lite - (C) University of Washington Interactive Data Lab https://vega.github.io/vega-lite/
Fontawesome - (C) Fonticons, Inc. All rights reserved https://fontawesome.com
All other code by Trafford Data Lab
Licence: Vega-Lite: https://github.com/vega/vega-lite/blob/master/LICENSE
Fontawesome: https://fontawesome.com/license
Trafford Data Lab: https://github.com/traffordDataLab/choroplether/blob/master/LICENSE
*/
// Test that we're not in IE11 or worse
if (navigator.userAgent.indexOf('MSIE') !== -1 || navigator.appVersion.indexOf('Trident/') > -1) {
// Insert a message into the UI interface container
document.getElementById('layoutContainer').innerHTML = '<h2>Unfortunately you need a modern browser to create Vega-Lite visualisations. Please upgrade or use this app in another browser.</h2>';
}
else {
// Reference commonly used objects
var vizContainer = document.getElementById('vegaLiteViz'); // the DIV where the visualisation is created
var updateIcon = document.getElementById('updateIcon'); // the span containing the font awesome icon for updating the visualisation
// Insert the default attribution into the input box based on the current year
document.getElementById('vizAttribution').value = 'Contains National Statistics & OS data © Crown copyright and database right ' + new Date().getFullYear();
// The Vega-Lite specification framework that forms the visualisation. Some objects are dynamically updated based on the user input
var vegaLiteSpec = {
"$schema": "https://vega.github.io/schema/vega-lite/v5.16.3.json",
"description": "Choropleth map visualisation created by https://www.trafforddatalab.io/choroplether.",
"autosize": "fit",
"width": 500,
"height": 500,
"title": {
"text": "",
"font": "Roboto",
"color": "#757575",
"fontSize": 18
},
"data": {
"url": document.getElementById("geographyList").value,
"format": {
"property": "features"
}
},
"projection": {
"type": "mercator"
},
"transform": [
{
"lookup": "properties.area_code",
"from": {
"key": "area_code",
"fields": ["value"]
}
},
{
"calculate": "geoCentroid(null, datum)",
"as": "centroid"
},
{
"calculate": "datum.centroid[0]",
"as": "centroidLon"
},
{
"calculate": "datum.centroid[1]",
"as": "centroidLat"
}
],
"layer": [
{
"mark": {
"type": "geoshape",
"stroke": "white",
"strokeWidth": 1
},
"encoding": {
"color": {
"field": "value",
"scale": {
"scheme": {
"name": document.getElementById("paletteList").value,
"count": 0
},
"type": document.getElementById("scaleList").value
},
"type": "quantitative",
"legend": {
"title": "",
"titleFont": "Roboto",
"titleColor": "#757575",
"direction": "horizontal",
"orient": "bottom",
"padding": 9
}
},
"tooltip": [
{
"field": "properties.area_name",
"type": "nominal",
"title": "Area"
},
{
"field": "value",
"type": "quantitative",
"title": "Value"
}
]
}
},
{
"data": {
"values": [
{
"note": document.getElementById('vizAttribution').value
}
]
},
"mark": {
"type": "text",
"align": "left",
"baseline": "bottom",
"dx": -40,
"dy": 283,
"fontSize": 8,
"tooltip": null
},
"encoding": {
"text": {"field": "note", "type": "nominal"}
}
},
{
"encoding": {
"longitude": {
"field": "centroidLon",
"type": "quantitative"
},
"latitude": {
"field": "centroidLat",
"type": "quantitative"
}
},
"layer": [] // blank array ready to contain map labels if required
}
],
"config": {
"view": {
"stroke": "transparent"
}
}
}
// List of all valid Vega sequential palettes which the user can enter into the 'other' palette input box
var vegaLiteSequentialPalettes = {
// single-hue
'blues': true,
'tealblues': true,
'teals': true,
'greens': true,
'browns': true,
'oranges': true,
'reds': true,
'purples': true,
'warmgreys': true,
'greys': true,
// multi-hue
'viridis': true,
'magma': true,
'inferno': true,
'plasma': true,
'bluegreen': true,
'bluepurple': true,
'goldgreen': true,
'goldorange': true,
'goldred': true,
'greenblue': true,
'orangered': true,
'purplebluegreen': true,
'purpleblue': true,
'purplered': true,
'redpurple': true,
'yellowgreenblue': true,
'yellowgreen': true,
'yelloworangebrown': true,
'yelloworangered': true,
'darkblue': true,
'darkgold': true,
'darkgreen': true,
'darkmulti': true,
'darkred': true,
'lightgreyred': true,
'lightgreyteal': true,
'lightmulti': true,
'lightorange': true,
'lighttealblue': true
}
var vizAreaLabelsContent = 'properties.area_name'; // This will be either area_name or area_code to use for the map area labels and tooltips
// ========= Console warn override to handle issues raised from the vegaEmbed catch clause =========
console.warnDefault = console.warn; // Cache the default action for warn
function displayErrorMessage(msg) {
var errMsg = (msg === undefined) ? 'Check the data and/or the geography you are using.' : msg;
vizContainer.innerHTML = '<h2>Sorry, cannot create the map.</h2><p>' + errMsg + '</p><p><span class="fa fa-exclamation-triangle" aria-hidden="true"></span></p>';
}
// overridden warn
console.warn = function (args) {
displayErrorMessage();
return console.warnDefault(args);
}
// =========
// ========= UI operations =========
// Performs CSS class add/remove etc. to show/hide content sections
function toggleContentSection(name) {
var elIcon = document.getElementById(name + 'ToggleIcon');
var elMsg = document.getElementById(name + 'ShowContent');
var elForm = document.getElementById(name + 'Form');
var elButton = document.getElementById(name + 'ToggleButton');
// Font Awesome icon in the legend
elIcon.classList.toggle('fa-minus');
elIcon.classList.toggle('fa-plus');
elMsg.classList.toggle('hideContent'); // message to show the full content
elForm.classList.toggle('hideContent'); // the main content of the fieldset
// Accessibility features
if (elIcon.classList == 'fa fa-minus') {
// section is expanded
elButton.setAttribute('aria-expanded', 'true');
elButton.parentNode.setAttribute('aria-label', name + ' section, expanded');
}
else {
// section is collapsed
elButton.setAttribute('aria-expanded', 'false');
elButton.parentNode.setAttribute('aria-label', name + ' section, collapsed');
}
}
// Convey to the user that something is loading by spinning the update button icon
function updateButtonSpin() {
updateIcon.classList.remove('fa-redo-alt');
updateIcon.classList.add('fa-spinner');
updateIcon.classList.add('fa-spin');
}
// Reset the update button back to its normal state after an update has been performed
function updateButtonReset() {
updateIcon.classList.remove('fa-spin');
updateIcon.classList.remove('fa-spinner');
updateIcon.classList.add('fa-redo-alt');
}
// =========
// ========= File loading capabilities, either from the local device or remotely =========
// Attempt to obtain a local file prior to processing
function localFileLoader(src, dest) {
if (src.value !== '') {
try {
var reader = new FileReader();
reader.onload = function (e) {
destEl = document.getElementById(dest);
destEl.value = e.target.result;
(dest === 'data') ? checkData(destEl) : checkGeography(destEl.value);
};
reader.readAsText(src.files[0]);
src.value = ''; // reset the value of the file input box in case the user chooses the same file again - as this would not result in the onchange event firing
}
catch(e) {
// we can't use window.FileReader or something else went wrong so inform the user
displayErrorMessage('Can\'t load local files using this browser.<br />Please provide the data using another method.');
}
}
}
// =========
// ========= Dynamic changes to the Vega-Lite specification based on user choices =========
// Check the input provided for the data of the visualisation
function checkData(el) {
// Only attempt parsing if there is content within the data box
if (el.value !== '' && el.value !== null) {
// Is the content a URL (must be https://) or pasted data?
if (el.value.substring(0, 8) === 'https://') {
vegaLiteSpec.transform[0].from.data = {
"url": el.value
}
}
else {
// the data must be in the box directly, either pasted or loaded locally
// if JSON.parse is used on non-JSON data it will throw a syntax error, hence the try-catch block
var data = el.value;
var format;
try {
data = JSON.parse(data); // attempt to parse as JSON
format = 'json';
}
catch(e) {
// assumption now is that the data is CSV
// the following regex lines deal with newline characters to ensure the data is presented correctly as a continous string within the Vega-Lite spec
data = data.replace(/\\n/g, '\n'); // replace actual string occurences of "\n" with newline characters
data = data.replace(/\n/g, '\n'); // replace any carriage returns with newline characters
format = 'csv';
el.value = data; // update the input field with the cleaned output
}
// add the data to the Vega-Lite spec
vegaLiteSpec.transform[0].from.data = {
"values": data,
"format": {
"type": format
}
}
}
}
else {
vegaLiteSpec.transform[0].from.data = {}; // the data box is empty so set the spec accordingly
}
createVisualisation(); // update the visualisation
}
// Handle the UI changes based on the selection in the geography list
function checkGeographyChoice(val) {
var customGeogContainer = document.getElementById('geographyCustom');
var geogVal = val;
if (geogVal === 'other') {
customGeogContainer.classList.remove('hideContent'); // remove the 'hideContent' class from the custom geography div
geogVal = document.getElementById('geography').value // NOTE: the onchange event of the 'geography' textbox also calls checkGeography()
document.getElementById('geographyCustomFile').focus();
}
else if (!customGeogContainer.classList.contains('hideContent')) {
customGeogContainer.classList.add('hideContent'); // add the 'hideContent' class to the custom geography div
}
checkGeography(geogVal);
}
// Check the input provided for the geography of the visualisation
function checkGeography(val) {
if (val !== '' && val !== null && val !== 'other') {
// Set up the common objects of the geography
vegaLiteSpec.data = {
"format": {
"property": "features"
}
}
// Is the content a URL (must be https://) or pasted data?
if (val.substring(0, 8) === 'https://') {
// Attempt to load GeoJSON specified in the URL to test if it exists and if so, so that we can validate it
labAjax(val, function (data) {
if (data !== null && data !== '') {
// If we have reached this point then the geography will have been successfully parsed and we know it's valid JSON
vegaLiteSpec.data.url = val; // create a URL object and set it to the URL provided
setupGeography(data); // setup all the geography-data key bindings, map labels and tooltips
}
else {
// Create an error message to inform the user that there is an issue with the geography - either the URL doesn't exist or access is forbidden/denied or it isn't valid JSON and so failed parsing.)
vegaLiteSpec.data.url = '';
displayErrorMessage('There is an issue with the geography URL.<br />Please check it exists and the file is GeoJSON.');
}
}, { type: 'json' });
}
else {
// The data must be in the box directly, either pasted or loaded locally
// If JSON.parse is used on non-JSON data it will throw a syntax error, hence the try-catch block
try {
var data = JSON.parse(val); // as GeoJSON is valid JSON, attempt to parse it
vegaLiteSpec.data.values = data; // create a data object and set it to the content provided in the box
setupGeography(data); // setup all the geography-data key bindings, map labels and tooltips
}
catch(e) {
// Create an error message to inform the user that the GeoJSON isn't valid
displayErrorMessage('The geography isn\'t valid GeoJSON.<br />Please check it and try again.');
}
}
}
}
// Setup all the geography-data key bindings, map labels and tooltips
function setupGeography(data) {
var hasAreaCode = data.features[0].properties.hasOwnProperty('area_code') ? true : false;
var hasAreaName = data.features[0].properties.hasOwnProperty('area_name') ? true : false;
if (hasAreaCode || hasAreaName) {
// Setup the data bindings, we prefer area_code but can use area_name if required (e.g. for Trafford localities)
if (hasAreaCode) {
vegaLiteSpec.transform[0].lookup = "properties.area_code";
vegaLiteSpec.transform[0].from.key = "area_code";
}
else {
vegaLiteSpec.transform[0].lookup = "properties.area_name";
vegaLiteSpec.transform[0].from.key = "area_name";
}
// Set up the tooltips and content for map area labels if required. We prefer area_name but can use area_code if required
if (hasAreaName) {
vizAreaLabelsContent = "properties.area_name";
}
else {
vizAreaLabelsContent = "properties.area_code";
}
vegaLiteSpec.layer[0].encoding.tooltip[0].field = vizAreaLabelsContent;
mapLabels();
createVisualisation(); // update the visualisation
}
else {
// Create an error message to inform the user that the GeoJSON doesn't contain the required property keys for binding to the data
displayErrorMessage('The geography doesn\'t contain area_code or area_name.<br />At least one is required to visualise the data.');
}
}
// Check the input provided for the visualisation title
function updateTitle(val) {
vegaLiteSpec.title.text = val; // set the title based on the content provided by the user
adjustAttributionPosition(); // ensure the vertical position of the attribution is correct
createVisualisation(); // update the visualisation
}
// Check the input provided for the legend title
function updateLegendTitle(val) {
vegaLiteSpec.layer[0].encoding.color.legend.title = val; // set the legend title based on the content provided by the user
adjustAttributionPosition(); // ensure the vertical position of the attribution is correct
createVisualisation(); // update the visualisation
}
// Check the input provided for the legend title
function updateAttribution(val) {
vegaLiteSpec.layer[1].data.values[0].note = val; // set the attribution based on the content provided by the user
adjustAttributionPosition(); // ensure the vertical position of the attribution is correct
createVisualisation(); // update the visualisation
}
// Make adjustments to the attribution's vertical offset depending on whether there are chart and/or legend titles
function adjustAttributionPosition() {
if (vegaLiteSpec.title.text !== '' && vegaLiteSpec.layer[0].encoding.color.legend.title === '') {
vegaLiteSpec.layer[1].mark.dy = 273;
}
else if (vegaLiteSpec.title.text === '' && vegaLiteSpec.layer[0].encoding.color.legend.title !== '') {
vegaLiteSpec.layer[1].mark.dy = 293;
}
else {
vegaLiteSpec.layer[1].mark.dy = 283;
}
}
// Handles the map labels (none, area names, area values, or both)
function mapLabels() {
areaNameLabelsRequired = document.getElementById('vizAreaLabels').checked;
areaValueLabelsRequired = document.getElementById('vizValueLabels').checked;
vegaLiteSpec.layer[2].layer = []; // Clear any current labels
if (areaNameLabelsRequired || areaValueLabelsRequired) {
// Add the circle marker at the polygon's centroid
vegaLiteSpec.layer[2].layer.push(
{
"mark": {
"type": "circle",
"size": 12,
"stroke": "#000",
"strokeWidth": 1,
"color": "#fff"
}
}
);
if (areaNameLabelsRequired) {
// Add the area name of the polygon above the centroid circle
// We add 2 text marks overlapping each other to create white text with a black outline
vegaLiteSpec.layer[2].layer.push(
{
"mark": {
"type": "text",
"dy": -12,
"stroke": "#000",
"strokeWidth": 1.5,
"fontWeight": "bold",
"limit": 70
},
"encoding": {
"text": {"field": vizAreaLabelsContent}
}
}
);
vegaLiteSpec.layer[2].layer.push(
{
"mark": {
"type": "text",
"dy": -12,
"color": "#fff",
"fontWeight": "bold",
"limit": 70
},
"encoding": {
"text": {"field": vizAreaLabelsContent}
}
}
);
}
if (areaValueLabelsRequired) {
// Add the value of the polygon below the centroid circle
// We add 2 text marks overlapping each other to create white text with a black outline
vegaLiteSpec.layer[2].layer.push(
{
"mark": {
"type": "text",
"dy": 12,
"stroke": "#000",
"strokeWidth": 1.5,
"fontWeight": "bold"
},
"encoding": {
"text": {"field": "value", "type": "quantitative"}
}
}
);
vegaLiteSpec.layer[2].layer.push(
{
"mark": {
"type": "text",
"dy": 12,
"color": "#fff",
"fontWeight": "bold"
},
"encoding": {
"text": {"field": "value", "type": "quantitative"}
}
}
);
}
}
createVisualisation(); // update the visualisation
}
// Updates the palette scheme name used by the visualisation
function updatePalette(el) {
var paletteName = el.value;
var paletteList = document.getElementById('paletteList'); // the palette select list
var paletteCustom = document.getElementById('paletteCustom'); // the container for the custom text box
if (paletteName === 'other') {
var paletteCustomInput = document.getElementById('palette');
// we need to make sure that the "other" palette text box is visible
if (paletteCustom.classList.contains('hideContent')) paletteCustom.classList.remove('hideContent');
// load the value from the text box ready for further testing below - it could be blank or have a previous value entered by the user
paletteName = paletteCustomInput.value;
// set focus to the custom palette input box
paletteCustomInput.focus();
}
else {
// we need to make sure that the "other" palette text box is hidden if the current select list value is not "other"
if (el === paletteList && !paletteCustom.classList.contains('hideContent')) paletteCustom.classList.add('hideContent');
}
if (paletteName !== '' && paletteName !== null && paletteName !== 'other') {
// Ensure that the value given is a valid sequential palette scheme.
// We do this by checking if there is a key with the same name in the object vegaLiteSequentialPalettes.
// If there is it will return true, otherwise null - saves looping through an array etc.
if (vegaLiteSequentialPalettes[paletteName.toLowerCase()]) {
vegaLiteSpec.layer[0].encoding.color.scale.scheme.name = paletteName; // uses the value from the palette list or the custom text box if the palette list option is "other"
createVisualisation(); // update the visualisation
}
else {
displayErrorMessage('The palette isn\'t a valid sequential Vega scheme.<br />Please check the list of valid scheme names.');
}
}
}
// Update the scale method, e.g. linear, quantile, quantize
function updateScale(val) {
var intervalsContainer = document.getElementById('intervalsContainer'); // the span around the intervals list
var intervalsMsg = document.getElementById('intervalsMsg'); // the span around the wording " and number of intervals"
// Handle whether the breaks select list should be visible or not
if (val === 'linear') {
// Intervals list should be hidden
if (!intervalsContainer.classList.contains('hideContent')) {
intervalsContainer.classList.add('hideContent');
intervalsMsg.classList.add('hideContent');
}
vegaLiteSpec.layer[0].encoding.color.scale.scheme.count = 0; // we don't want a number of breaks as the interval is linear
}
else {
// Intervals list should be visible
if (intervalsContainer.classList.contains('hideContent')) {
intervalsContainer.classList.remove('hideContent');
intervalsMsg.classList.remove('hideContent');
}
vegaLiteSpec.layer[0].encoding.color.scale.scheme.count = parseInt(document.getElementById('intervalsList').value);
}
vegaLiteSpec.layer[0].encoding.color.scale.type = val; // set the interval type in the spec
createVisualisation();
}
// Update the number of breaks to use
function updateIntervals(val) {
vegaLiteSpec.layer[0].encoding.color.scale.scheme.count = parseInt(val);
createVisualisation();
}
// =========
// Embed the visualisation within the page
function createVisualisation() {
updateButtonSpin();
vizContainer.innerHTML = ''; // clear any previous visualisation
try {
vegaEmbed('#vegaLiteViz', vegaLiteSpec, {defaultStyle: true}).then(function(result) {
updateButtonReset();
}).catch(function (error) {
displayErrorMessage();
updateButtonReset();
});
}
catch(e) {
// unexpected error
displayErrorMessage('An unexpected error occurred:<br />' + e.message);
updateButtonReset();
}
// add accessibility aria-label to the <detail>s action menu to explain its purpose
// has to be done in a setInterval in case the <details> element hasn't been created yet
var actionMenuA11yCb;
actionMenuA11yCb = setInterval(function () {
try {