@basemaps/landing 6.46.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +0 -2
  3. package/dist/docs/404.html +824 -0
  4. package/dist/docs/assets/images/favicon.png +0 -0
  5. package/dist/docs/assets/javascripts/bundle.cd18aaf1.min.js +29 -0
  6. package/dist/docs/assets/javascripts/bundle.cd18aaf1.min.js.map +7 -0
  7. package/dist/docs/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  8. package/dist/docs/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  9. package/dist/docs/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  10. package/dist/docs/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  11. package/dist/docs/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
  12. package/dist/docs/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  13. package/dist/docs/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  14. package/dist/docs/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  15. package/dist/docs/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
  16. package/dist/docs/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
  17. package/dist/docs/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  18. package/dist/docs/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
  19. package/dist/docs/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  20. package/dist/docs/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  21. package/dist/docs/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  22. package/dist/docs/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
  23. package/dist/docs/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
  24. package/dist/docs/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  25. package/dist/docs/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  26. package/dist/docs/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  27. package/dist/docs/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  28. package/dist/docs/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  29. package/dist/docs/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  30. package/dist/docs/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
  31. package/dist/docs/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  32. package/dist/docs/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  33. package/dist/docs/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
  34. package/dist/docs/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
  35. package/dist/docs/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
  36. package/dist/docs/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  37. package/dist/docs/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  38. package/dist/docs/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
  39. package/dist/docs/assets/javascripts/lunr/tinyseg.js +206 -0
  40. package/dist/docs/assets/javascripts/lunr/wordcut.js +6708 -0
  41. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js +42 -0
  42. package/dist/docs/assets/javascripts/workers/search.f886a092.min.js.map +7 -0
  43. package/dist/docs/assets/stylesheets/main.fad675c6.min.css +1 -0
  44. package/dist/docs/assets/stylesheets/main.fad675c6.min.css.map +1 -0
  45. package/dist/docs/assets/stylesheets/palette.356b1318.min.css +1 -0
  46. package/dist/docs/assets/stylesheets/palette.356b1318.min.css.map +1 -0
  47. package/dist/docs/configuration/index.html +981 -0
  48. package/dist/docs/deployment/index.html +932 -0
  49. package/dist/docs/developer-guide/index.html +884 -0
  50. package/dist/docs/examples/_overview/index.html +870 -0
  51. package/dist/docs/examples/index.leaflet.xyz.3857.html +38 -0
  52. package/dist/docs/examples/index.maplibre.opacity.3857.html +215 -0
  53. package/dist/docs/examples/index.maplibre.vector.3857.html +45 -0
  54. package/dist/docs/examples/leaflet.xyz.3857/index.html +904 -0
  55. package/dist/docs/examples/maplibre.opacity.3857/index.html +1081 -0
  56. package/dist/docs/examples/maplibre.vector.3857/index.html +911 -0
  57. package/dist/docs/index.css +3 -0
  58. package/dist/docs/index.html +1141 -0
  59. package/dist/docs/linz-motif.svg +124 -0
  60. package/dist/docs/operator-guide/cog-quality/index.html +1121 -0
  61. package/dist/docs/operator-guide/empty-tiles/index.html +990 -0
  62. package/dist/docs/operator-guide/index.html +859 -0
  63. package/dist/docs/operator-guide/quick-start/index.html +1104 -0
  64. package/dist/docs/operator-guide/relief-shade/index.html +971 -0
  65. package/dist/docs/operator-guide/static/2023-06-26-gisborne-2023.png +0 -0
  66. package/dist/docs/operator-guide/static/quality__005_006_0_bilinear.webp +0 -0
  67. package/dist/docs/operator-guide/static/quality__005_006_0_lanczos.webp +0 -0
  68. package/dist/docs/operator-guide/static/quality__i6.bilinear.webp +0 -0
  69. package/dist/docs/operator-guide/static/quality__i6.cubic.webp +0 -0
  70. package/dist/docs/operator-guide/static/quality__i6.lanczos.webp +0 -0
  71. package/dist/docs/operator-guide/static/quality__resampling-overview.webp +0 -0
  72. package/dist/docs/operator-guide/static/quick-start__layers.png +0 -0
  73. package/dist/docs/operator-guide/static/relief__aerial.webp +0 -0
  74. package/dist/docs/operator-guide/static/relief__base.webp +0 -0
  75. package/dist/docs/operator-guide/static/relief__darken.webp +0 -0
  76. package/dist/docs/operator-guide/static/relief__lighten.webp +0 -0
  77. package/dist/docs/operator-guide/texture-shade/index.html +1014 -0
  78. package/dist/docs/quick-start/index.html +872 -0
  79. package/dist/docs/search/search_index.json +1 -0
  80. package/dist/docs/sitemap.xml +83 -0
  81. package/dist/docs/sitemap.xml.gz +0 -0
  82. package/dist/docs/static/basemaps-service.png +0 -0
  83. package/dist/docs/static/tile-resize.png +0 -0
  84. package/dist/docs/static/workflow-run.png +0 -0
  85. package/dist/docs/user-guide/index.html +856 -0
  86. package/package.json +7 -7
@@ -0,0 +1,981 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+
10
+
11
+ <link rel="canonical" href="http://localhost:8000/docs/configuration/">
12
+
13
+
14
+ <link rel="prev" href="..">
15
+
16
+
17
+ <link rel="next" href="../deployment/">
18
+
19
+
20
+ <link rel="icon" href="../assets/images/favicon.png">
21
+ <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.14">
22
+
23
+
24
+
25
+ <title>Configuration - LINZ Basemaps</title>
26
+
27
+
28
+
29
+ <link rel="stylesheet" href="../assets/stylesheets/main.fad675c6.min.css">
30
+
31
+
32
+ <link rel="stylesheet" href="../assets/stylesheets/palette.356b1318.min.css">
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
46
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i%7COpen+Sans+Mono:400,400i,700,700i&display=fallback">
47
+ <style>:root{--md-text-font:"Open Sans";--md-code-font:"Open Sans Mono"}</style>
48
+
49
+
50
+
51
+ <link rel="stylesheet" href="../index.css">
52
+
53
+ <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+ <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config",""),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
63
+
64
+ <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
65
+
66
+
67
+
68
+
69
+
70
+ </head>
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
81
+
82
+
83
+
84
+ <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
85
+
86
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
87
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
88
+ <label class="md-overlay" for="__drawer"></label>
89
+ <div data-md-component="skip">
90
+
91
+
92
+ <a href="#configuration" class="md-skip">
93
+ Skip to content
94
+ </a>
95
+
96
+ </div>
97
+ <div data-md-component="announce">
98
+
99
+ </div>
100
+
101
+
102
+
103
+
104
+
105
+
106
+ <header class="md-header md-header--shadow" data-md-component="header">
107
+ <nav class="md-header__inner md-grid" aria-label="Header">
108
+ <a href=".." title="LINZ Basemaps" class="md-header__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
109
+
110
+ <img src="../linz-motif.svg" alt="logo">
111
+
112
+ </a>
113
+ <label class="md-header__button md-icon" for="__drawer">
114
+
115
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
116
+ </label>
117
+ <div class="md-header__title" data-md-component="header-title">
118
+ <div class="md-header__ellipsis">
119
+ <div class="md-header__topic">
120
+ <span class="md-ellipsis">
121
+ LINZ Basemaps
122
+ </span>
123
+ </div>
124
+ <div class="md-header__topic" data-md-component="header-topic">
125
+ <span class="md-ellipsis">
126
+
127
+ Configuration
128
+
129
+ </span>
130
+ </div>
131
+ </div>
132
+ </div>
133
+
134
+
135
+ <form class="md-header__option" data-md-component="palette">
136
+
137
+
138
+
139
+
140
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
141
+
142
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
143
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
144
+ </label>
145
+
146
+
147
+
148
+
149
+
150
+ <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
151
+
152
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
153
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
154
+ </label>
155
+
156
+
157
+ </form>
158
+
159
+
160
+
161
+
162
+ <label class="md-header__button md-icon" for="__search">
163
+
164
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
165
+ </label>
166
+ <div class="md-search" data-md-component="search" role="dialog">
167
+ <label class="md-search__overlay" for="__search"></label>
168
+ <div class="md-search__inner" role="search">
169
+ <form class="md-search__form" name="search">
170
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
171
+ <label class="md-search__icon md-icon" for="__search">
172
+
173
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
174
+
175
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
176
+ </label>
177
+ <nav class="md-search__options" aria-label="Search">
178
+
179
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
180
+
181
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
182
+ </button>
183
+ </nav>
184
+
185
+ </form>
186
+ <div class="md-search__output">
187
+ <div class="md-search__scrollwrap" data-md-scrollfix>
188
+ <div class="md-search-result" data-md-component="search-result">
189
+ <div class="md-search-result__meta">
190
+ Initializing search
191
+ </div>
192
+ <ol class="md-search-result__list" role="presentation"></ol>
193
+ </div>
194
+ </div>
195
+ </div>
196
+ </div>
197
+ </div>
198
+
199
+
200
+ <div class="md-header__source">
201
+ <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
202
+ <div class="md-source__icon md-icon">
203
+
204
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
205
+ </div>
206
+ <div class="md-source__repository">
207
+ GitHub
208
+ </div>
209
+ </a>
210
+ </div>
211
+
212
+ </nav>
213
+
214
+ </header>
215
+
216
+ <div class="md-container" data-md-component="container">
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <main class="md-main" data-md-component="main">
224
+ <div class="md-main__inner md-grid">
225
+
226
+
227
+
228
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
229
+ <div class="md-sidebar__scrollwrap">
230
+ <div class="md-sidebar__inner">
231
+
232
+
233
+
234
+
235
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
236
+ <label class="md-nav__title" for="__drawer">
237
+ <a href=".." title="LINZ Basemaps" class="md-nav__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
238
+
239
+ <img src="../linz-motif.svg" alt="logo">
240
+
241
+ </a>
242
+ LINZ Basemaps
243
+ </label>
244
+
245
+ <div class="md-nav__source">
246
+ <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
247
+ <div class="md-source__icon md-icon">
248
+
249
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
250
+ </div>
251
+ <div class="md-source__repository">
252
+ GitHub
253
+ </div>
254
+ </a>
255
+ </div>
256
+
257
+ <ul class="md-nav__list" data-md-scrollfix>
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <li class="md-nav__item">
266
+ <a href=".." class="md-nav__link">
267
+
268
+
269
+ <span class="md-ellipsis">
270
+ LINZ Basemaps
271
+ </span>
272
+
273
+
274
+ </a>
275
+ </li>
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+ <li class="md-nav__item md-nav__item--active">
288
+
289
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
290
+
291
+
292
+
293
+ <label class="md-nav__link md-nav__link--active" for="__toc">
294
+
295
+
296
+ <span class="md-ellipsis">
297
+ Configuration
298
+ </span>
299
+
300
+
301
+ <span class="md-nav__icon md-icon"></span>
302
+ </label>
303
+
304
+ <a href="./" class="md-nav__link md-nav__link--active">
305
+
306
+
307
+ <span class="md-ellipsis">
308
+ Configuration
309
+ </span>
310
+
311
+
312
+ </a>
313
+
314
+
315
+
316
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
317
+
318
+
319
+
320
+
321
+ <label class="md-nav__title" for="__toc">
322
+ <span class="md-nav__icon md-icon"></span>
323
+ Table of contents
324
+ </label>
325
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
326
+
327
+ <li class="md-nav__item">
328
+ <a href="#configuration" class="md-nav__link">
329
+ <span class="md-ellipsis">
330
+ Configuration
331
+ </span>
332
+ </a>
333
+
334
+ <nav class="md-nav" aria-label="Configuration">
335
+ <ul class="md-nav__list">
336
+
337
+ <li class="md-nav__item">
338
+ <a href="#dynamic-configuration" class="md-nav__link">
339
+ <span class="md-ellipsis">
340
+ Dynamic configuration
341
+ </span>
342
+ </a>
343
+
344
+ </li>
345
+
346
+ </ul>
347
+ </nav>
348
+
349
+ </li>
350
+
351
+ </ul>
352
+
353
+ </nav>
354
+
355
+ </li>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+ <li class="md-nav__item">
366
+ <a href="../deployment/" class="md-nav__link">
367
+
368
+
369
+ <span class="md-ellipsis">
370
+ Deployment
371
+ </span>
372
+
373
+
374
+ </a>
375
+ </li>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ <li class="md-nav__item">
386
+ <a href="../quick-start/" class="md-nav__link">
387
+
388
+
389
+ <span class="md-ellipsis">
390
+ Quick start guide
391
+ </span>
392
+
393
+
394
+ </a>
395
+ </li>
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ <li class="md-nav__item md-nav__item--nested">
417
+
418
+
419
+
420
+
421
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
422
+
423
+
424
+
425
+ <div class="md-nav__link md-nav__container">
426
+ <a href="../developer-guide/" class="md-nav__link ">
427
+
428
+
429
+ <span class="md-ellipsis">
430
+ Developer guide
431
+ </span>
432
+
433
+
434
+ </a>
435
+
436
+ </div>
437
+
438
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
439
+ <label class="md-nav__title" for="__nav_5">
440
+ <span class="md-nav__icon md-icon"></span>
441
+ Developer guide
442
+ </label>
443
+ <ul class="md-nav__list" data-md-scrollfix>
444
+
445
+
446
+
447
+ </ul>
448
+ </nav>
449
+
450
+ </li>
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
+ <li class="md-nav__item md-nav__item--nested">
476
+
477
+
478
+
479
+
480
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
481
+
482
+
483
+ <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
484
+
485
+
486
+ <span class="md-ellipsis">
487
+ Examples
488
+ </span>
489
+
490
+
491
+ <span class="md-nav__icon md-icon"></span>
492
+ </label>
493
+
494
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
495
+ <label class="md-nav__title" for="__nav_6">
496
+ <span class="md-nav__icon md-icon"></span>
497
+ Examples
498
+ </label>
499
+ <ul class="md-nav__list" data-md-scrollfix>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+ <li class="md-nav__item">
508
+ <a href="../examples/_overview/" class="md-nav__link">
509
+
510
+
511
+ <span class="md-ellipsis">
512
+ Overview
513
+ </span>
514
+
515
+
516
+ </a>
517
+ </li>
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+ <li class="md-nav__item">
529
+ <a href="../examples/leaflet.xyz.3857/" class="md-nav__link">
530
+
531
+
532
+ <span class="md-ellipsis">
533
+ Leaflet Raster Map
534
+ </span>
535
+
536
+
537
+ </a>
538
+ </li>
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+ <li class="md-nav__item">
550
+ <a href="../examples/maplibre.opacity.3857/" class="md-nav__link">
551
+
552
+
553
+ <span class="md-ellipsis">
554
+ Maplibre Opacity Slider
555
+ </span>
556
+
557
+
558
+ </a>
559
+ </li>
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+ <li class="md-nav__item">
571
+ <a href="../examples/maplibre.vector.3857/" class="md-nav__link">
572
+
573
+
574
+ <span class="md-ellipsis">
575
+ Maplibre Vector Map
576
+ </span>
577
+
578
+
579
+ </a>
580
+ </li>
581
+
582
+
583
+
584
+
585
+ </ul>
586
+ </nav>
587
+
588
+ </li>
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
+ <li class="md-nav__item md-nav__item--nested">
620
+
621
+
622
+
623
+
624
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
625
+
626
+
627
+
628
+ <div class="md-nav__link md-nav__container">
629
+ <a href="../operator-guide/" class="md-nav__link ">
630
+
631
+
632
+ <span class="md-ellipsis">
633
+ Operator guide
634
+ </span>
635
+
636
+
637
+ </a>
638
+
639
+
640
+ <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
641
+ <span class="md-nav__icon md-icon"></span>
642
+ </label>
643
+
644
+ </div>
645
+
646
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
647
+ <label class="md-nav__title" for="__nav_7">
648
+ <span class="md-nav__icon md-icon"></span>
649
+ Operator guide
650
+ </label>
651
+ <ul class="md-nav__list" data-md-scrollfix>
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ <li class="md-nav__item">
662
+ <a href="../operator-guide/cog-quality/" class="md-nav__link">
663
+
664
+
665
+ <span class="md-ellipsis">
666
+ COG Quality
667
+ </span>
668
+
669
+
670
+ </a>
671
+ </li>
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+ <li class="md-nav__item">
683
+ <a href="../operator-guide/empty-tiles/" class="md-nav__link">
684
+
685
+
686
+ <span class="md-ellipsis">
687
+ Sparse Datasets and empty tiles
688
+ </span>
689
+
690
+
691
+ </a>
692
+ </li>
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+ <li class="md-nav__item">
704
+ <a href="../operator-guide/quick-start/" class="md-nav__link">
705
+
706
+
707
+ <span class="md-ellipsis">
708
+ Running LINZ Basemaps - Quick Start
709
+ </span>
710
+
711
+
712
+ </a>
713
+ </li>
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+ <li class="md-nav__item">
725
+ <a href="../operator-guide/relief-shade/" class="md-nav__link">
726
+
727
+
728
+ <span class="md-ellipsis">
729
+ Relief shade
730
+ </span>
731
+
732
+
733
+ </a>
734
+ </li>
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+ <li class="md-nav__item">
746
+ <a href="../operator-guide/texture-shade/" class="md-nav__link">
747
+
748
+
749
+ <span class="md-ellipsis">
750
+ Texture shading
751
+ </span>
752
+
753
+
754
+ </a>
755
+ </li>
756
+
757
+
758
+
759
+
760
+ </ul>
761
+ </nav>
762
+
763
+ </li>
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+ <li class="md-nav__item md-nav__item--nested">
785
+
786
+
787
+
788
+
789
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
790
+
791
+
792
+
793
+ <div class="md-nav__link md-nav__container">
794
+ <a href="../user-guide/" class="md-nav__link ">
795
+
796
+
797
+ <span class="md-ellipsis">
798
+ User guide
799
+ </span>
800
+
801
+
802
+ </a>
803
+
804
+ </div>
805
+
806
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
807
+ <label class="md-nav__title" for="__nav_8">
808
+ <span class="md-nav__icon md-icon"></span>
809
+ User guide
810
+ </label>
811
+ <ul class="md-nav__list" data-md-scrollfix>
812
+
813
+
814
+
815
+ </ul>
816
+ </nav>
817
+
818
+ </li>
819
+
820
+
821
+
822
+ </ul>
823
+ </nav>
824
+ </div>
825
+ </div>
826
+ </div>
827
+
828
+
829
+
830
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
831
+ <div class="md-sidebar__scrollwrap">
832
+ <div class="md-sidebar__inner">
833
+
834
+
835
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
836
+
837
+
838
+
839
+
840
+ <label class="md-nav__title" for="__toc">
841
+ <span class="md-nav__icon md-icon"></span>
842
+ Table of contents
843
+ </label>
844
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
845
+
846
+ <li class="md-nav__item">
847
+ <a href="#configuration" class="md-nav__link">
848
+ <span class="md-ellipsis">
849
+ Configuration
850
+ </span>
851
+ </a>
852
+
853
+ <nav class="md-nav" aria-label="Configuration">
854
+ <ul class="md-nav__list">
855
+
856
+ <li class="md-nav__item">
857
+ <a href="#dynamic-configuration" class="md-nav__link">
858
+ <span class="md-ellipsis">
859
+ Dynamic configuration
860
+ </span>
861
+ </a>
862
+
863
+ </li>
864
+
865
+ </ul>
866
+ </nav>
867
+
868
+ </li>
869
+
870
+ </ul>
871
+
872
+ </nav>
873
+ </div>
874
+ </div>
875
+ </div>
876
+
877
+
878
+
879
+ <div class="md-content" data-md-component="content">
880
+ <article class="md-content__inner md-typeset">
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+ <h1>Configuration</h1>
889
+
890
+ <h2 id="configuration">Configuration</h2>
891
+ <p>Basemaps has two main components to its configuration</p>
892
+ <ul>
893
+ <li>Imagery - List of tiffs that make up a imagery set</li>
894
+ <li>TileSet - List of imagery or vector layers that make up a output layer.</li>
895
+ </ul>
896
+ <p>The configuration can be stored as individual AWS DynamoDB objects or can be stored as a bundled JSON object.</p>
897
+ <p>The configuration is generally generated directly from the source tiffs and associated STAC metadata using the <a href="../packages/cli/README.md">@basemaps/cli</a> import process, with LINZ's specific configuration being stored in <a href="https://github.com/linz/basemaps-config">linz/basemaps-config</a>.</p>
898
+ <p>This allows the configuration objects to be somewhat short, below is a snippet from the <a href="https://github.com/linz/basemaps-config/blob/master/config/tileset/aerial.json">aerial</a> tile set configuration which layers 100+ aerial imagery layers together.</p>
899
+ <div class="language-json highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">{</span>
900
+ </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="c1">// Raster or Vector layer</span>
901
+ </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;raster&quot;</span><span class="p">,</span>
902
+ </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="c1">// all id&#39;s are prefixed by type eg &#39;ts_&#39; is TileSet</span>
903
+ </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ts_aerial&quot;</span><span class="p">,</span>
904
+ </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="c1">// Human friendly name</span>
905
+ </span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Aerial Imagery Basemap&quot;</span><span class="p">,</span>
906
+ </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nt">&quot;category&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Basemaps&quot;</span><span class="p">,</span>
907
+ </span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="c1">// If there is no data create a background color as hex RGBA</span>
908
+ </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">&quot;background&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;dce9edff&quot;</span><span class="p">,</span>
909
+ </span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="nt">&quot;layers&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
910
+ </span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span><span class="p">{</span>
911
+ </span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span><span class="c1">// Source location for EPSG:2193 Imagery</span>
912
+ </span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w"> </span><span class="nt">&quot;2193&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;s3://linz-basemaps/2193/gebco_2020_Nztm2000Quad_305-75m/01F1BFJN8R8P7BXN3XTHC5MT5G&quot;</span><span class="p">,</span>
913
+ </span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w"> </span><span class="c1">// Source location for EPSG:3857 Imagery</span>
914
+ </span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w"> </span><span class="nt">&quot;3857&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;s3://linz-basemaps/3857/gebco_2020_305-75m/01EDMTM3P563P06TWYQAZRA9F6&quot;</span><span class="p">,</span>
915
+ </span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span><span class="c1">// url/slug friendly name of the imagery set</span>
916
+ </span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;gebco-2020-305.75m&quot;</span><span class="p">,</span>
917
+ </span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="w"> </span><span class="c1">// At what level should the imagery be turned off</span>
918
+ </span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="w"> </span><span class="nt">&quot;maxZoom&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">15</span><span class="p">,</span>
919
+ </span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="w"> </span><span class="c1">// Human friendly name for the imagery</span>
920
+ </span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;GEBCO Gridded Bathymetry (2020)&quot;</span><span class="p">,</span>
921
+ </span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="w"> </span><span class="nt">&quot;category&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Bathymetry&quot;</span>
922
+ </span><span id="__span-0-24"><a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a><span class="w"> </span><span class="p">},</span>
923
+ </span><span id="__span-0-25"><a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="w"> </span><span class="err">...</span>
924
+ </span><span id="__span-0-26"><a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="w"> </span><span class="p">]</span>
925
+ </span><span id="__span-0-27"><a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a><span class="p">}</span>
926
+ </span></code></pre></div>
927
+ <p>When this configuration is imported it will list all of the source locations looking for <code>collection.json</code> and <code>*.tiff|*.tif</code> files.</p>
928
+ <h3 id="dynamic-configuration">Dynamic configuration</h3>
929
+ <p>Configuration can be stored as single JSON object in s3 and then passed directly to the basemaps service with <code>?config=s3://linz-basemaps/config/config-latest.json.gz</code> this allows basemaps to preview a configuration before being deployed.</p>
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+ </article>
939
+ </div>
940
+
941
+
942
+ </div>
943
+
944
+ </main>
945
+
946
+ <footer class="md-footer">
947
+
948
+ <div class="md-footer-meta md-typeset">
949
+ <div class="md-footer-meta__inner md-grid">
950
+ <div class="md-copyright">
951
+
952
+ <div class="md-copyright__highlight">
953
+ <a href="https://www.linz.govt.nz/copyright">© CC BY 4.0 LINZ</a>
954
+ </div>
955
+
956
+
957
+ Made with
958
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
959
+ Material for MkDocs
960
+ </a>
961
+
962
+ </div>
963
+
964
+ </div>
965
+ </div>
966
+ </footer>
967
+
968
+ </div>
969
+ <div class="md-dialog" data-md-component="dialog">
970
+ <div class="md-dialog__inner md-typeset"></div>
971
+ </div>
972
+
973
+
974
+ <script id="__config" type="application/json">{"base": "..", "features": ["navigation.indexes", "content.code.copy"], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
975
+
976
+
977
+ <script src="../assets/javascripts/bundle.cd18aaf1.min.js"></script>
978
+
979
+
980
+ </body>
981
+ </html>