@basemaps/landing 7.0.0 → 7.1.1

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 (142) hide show
  1. package/README.md +2 -2
  2. package/build/__tests__/config.debug.test.d.ts +0 -1
  3. package/build/__tests__/config.debug.test.js +11 -10
  4. package/build/__tests__/config.debug.test.js.map +1 -1
  5. package/build/__tests__/config.test.d.ts +0 -1
  6. package/build/__tests__/config.test.js +5 -4
  7. package/build/__tests__/config.test.js.map +1 -1
  8. package/build/__tests__/geojson.test.d.ts +0 -1
  9. package/build/__tests__/geojson.test.js +6 -5
  10. package/build/__tests__/geojson.test.js.map +1 -1
  11. package/build/__tests__/map.config.test.d.ts +0 -1
  12. package/build/__tests__/map.config.test.js +66 -65
  13. package/build/__tests__/map.config.test.js.map +1 -1
  14. package/build/__tests__/tile.matrix.test.d.ts +0 -1
  15. package/build/__tests__/tile.matrix.test.js +11 -10
  16. package/build/__tests__/tile.matrix.test.js.map +1 -1
  17. package/build/attribution.d.ts +8 -11
  18. package/build/attribution.js +145 -66
  19. package/build/attribution.js.map +1 -1
  20. package/build/components/copyable.d.ts +1 -2
  21. package/build/components/copyable.js +27 -18
  22. package/build/components/copyable.js.map +1 -1
  23. package/build/components/daterange.d.ts +0 -1
  24. package/build/components/daterange.js +11 -7
  25. package/build/components/daterange.js.map +1 -1
  26. package/build/components/debug.d.ts +13 -2
  27. package/build/components/debug.js +273 -78
  28. package/build/components/debug.js.map +1 -1
  29. package/build/components/layer.switcher.dropdown.d.ts +1 -2
  30. package/build/components/layer.switcher.dropdown.js +43 -29
  31. package/build/components/layer.switcher.dropdown.js.map +1 -1
  32. package/build/components/layout.footer.d.ts +0 -1
  33. package/build/components/layout.footer.js +7 -2
  34. package/build/components/layout.footer.js.map +1 -1
  35. package/build/components/layout.header.d.ts +1 -2
  36. package/build/components/layout.header.js +44 -23
  37. package/build/components/layout.header.js.map +1 -1
  38. package/build/components/link.d.ts +0 -1
  39. package/build/components/link.js +1 -1
  40. package/build/components/link.js.map +1 -1
  41. package/build/components/map.d.ts +14 -4
  42. package/build/components/map.js +221 -84
  43. package/build/components/map.js.map +1 -1
  44. package/build/components/map.switcher.d.ts +1 -2
  45. package/build/components/map.switcher.js +80 -31
  46. package/build/components/map.switcher.js.map +1 -1
  47. package/build/config.d.ts +0 -1
  48. package/build/config.debug.d.ts +6 -1
  49. package/build/config.debug.js +6 -0
  50. package/build/config.debug.js.map +1 -1
  51. package/build/config.js +4 -8
  52. package/build/config.js.map +1 -1
  53. package/build/config.layer.d.ts +31 -2
  54. package/build/config.layer.js +14 -6
  55. package/build/config.layer.js.map +1 -1
  56. package/build/config.map.d.ts +6 -6
  57. package/build/config.map.js +95 -29
  58. package/build/config.map.js.map +1 -1
  59. package/build/debug.map.d.ts +2 -3
  60. package/build/debug.map.js +57 -23
  61. package/build/debug.map.js.map +1 -1
  62. package/build/global.d.ts +3 -3
  63. package/build/index.d.ts +0 -1
  64. package/build/index.js.map +1 -1
  65. package/build/tile.matrix.d.ts +0 -1
  66. package/build/tile.matrix.js +12 -0
  67. package/build/tile.matrix.js.map +1 -1
  68. package/build/url.d.ts +4 -1
  69. package/build/url.js +10 -8
  70. package/build/url.js.map +1 -1
  71. package/build/webp.d.ts +0 -1
  72. package/build/webp.js.map +1 -1
  73. package/dist/docs/404.html +88 -63
  74. package/dist/docs/assets/javascripts/{bundle.cd18aaf1.min.js → bundle.6c14ae12.min.js} +6 -6
  75. package/dist/docs/assets/javascripts/{bundle.cd18aaf1.min.js.map → bundle.6c14ae12.min.js.map} +3 -3
  76. package/dist/docs/assets/javascripts/swagger-initializer.js +20 -0
  77. package/dist/docs/assets/javascripts/swagger-ui-bundle.js +3 -0
  78. package/dist/docs/assets/javascripts/swagger-ui-bundle.js.map +1 -0
  79. package/dist/docs/assets/javascripts/swagger-ui-es-bundle-core.js +3 -0
  80. package/dist/docs/assets/javascripts/swagger-ui-es-bundle-core.js.map +1 -0
  81. package/dist/docs/assets/javascripts/swagger-ui-es-bundle.js +3 -0
  82. package/dist/docs/assets/javascripts/swagger-ui-es-bundle.js.map +1 -0
  83. package/dist/docs/assets/javascripts/swagger-ui-standalone-preset.js +3 -0
  84. package/dist/docs/assets/javascripts/swagger-ui-standalone-preset.js.map +1 -0
  85. package/dist/docs/assets/stylesheets/swagger-ui-dark.css +833 -0
  86. package/dist/docs/assets/stylesheets/swagger-ui.css +3 -0
  87. package/dist/docs/assets/stylesheets/swagger-ui.css.map +1 -0
  88. package/dist/docs/assets/stylesheets/swagger-ui.js +2 -0
  89. package/dist/docs/assets/stylesheets/swagger-ui.js.map +1 -0
  90. package/dist/docs/assets/swagger-ui/oauth2-redirect.html +79 -0
  91. package/dist/docs/configuration/index.html +397 -875
  92. package/dist/docs/deployment/index.html +354 -829
  93. package/dist/docs/developer-guide/index.html +343 -793
  94. package/dist/docs/examples/_overview/index.html +335 -792
  95. package/dist/docs/examples/leaflet.xyz.3857/index.html +371 -827
  96. package/dist/docs/examples/maplibre.opacity.3857/index.html +548 -1004
  97. package/dist/docs/examples/maplibre.vector.3857/index.html +378 -834
  98. package/dist/docs/index.html +442 -960
  99. package/dist/docs/operator-guide/cog-quality/index.html +455 -968
  100. package/dist/docs/operator-guide/empty-tiles/index.html +354 -831
  101. package/dist/docs/operator-guide/gebco/index.html +479 -0
  102. package/dist/docs/operator-guide/index.html +331 -777
  103. package/dist/docs/operator-guide/quick-start/index.html +445 -938
  104. package/dist/docs/operator-guide/relief-shade/index.html +377 -858
  105. package/dist/docs/operator-guide/texture-shade/index.html +438 -915
  106. package/dist/docs/quick-start/index.html +332 -785
  107. package/dist/docs/sitemap.xml +32 -17
  108. package/dist/docs/sitemap.xml.gz +0 -0
  109. package/dist/docs/user-guide/_get-started/index.html +602 -0
  110. package/dist/docs/user-guide/api-documentation/index.html +409 -0
  111. package/dist/docs/user-guide/api-documentation/swagger-12014783.html +120 -0
  112. package/dist/docs/user-guide/swagger-api.json +393 -0
  113. package/dist/docs/user-guide/technical-documentation/index.html +930 -0
  114. package/package.json +17 -17
  115. package/CHANGELOG.md +0 -1393
  116. package/build/__tests__/config.debug.test.d.ts.map +0 -1
  117. package/build/__tests__/config.test.d.ts.map +0 -1
  118. package/build/__tests__/geojson.test.d.ts.map +0 -1
  119. package/build/__tests__/map.config.test.d.ts.map +0 -1
  120. package/build/__tests__/tile.matrix.test.d.ts.map +0 -1
  121. package/build/attribution.d.ts.map +0 -1
  122. package/build/components/copyable.d.ts.map +0 -1
  123. package/build/components/daterange.d.ts.map +0 -1
  124. package/build/components/debug.d.ts.map +0 -1
  125. package/build/components/layer.switcher.dropdown.d.ts.map +0 -1
  126. package/build/components/layout.footer.d.ts.map +0 -1
  127. package/build/components/layout.header.d.ts.map +0 -1
  128. package/build/components/link.d.ts.map +0 -1
  129. package/build/components/map.d.ts.map +0 -1
  130. package/build/components/map.switcher.d.ts.map +0 -1
  131. package/build/config.d.ts.map +0 -1
  132. package/build/config.debug.d.ts.map +0 -1
  133. package/build/config.layer.d.ts.map +0 -1
  134. package/build/config.map.d.ts.map +0 -1
  135. package/build/debug.map.d.ts.map +0 -1
  136. package/build/global.d.ts.map +0 -1
  137. package/build/index.d.ts.map +0 -1
  138. package/build/tile.matrix.d.ts.map +0 -1
  139. package/build/url.d.ts.map +0 -1
  140. package/build/webp.d.ts.map +0 -1
  141. package/dist/docs/search/search_index.json +0 -1
  142. package/dist/docs/user-guide/index.html +0 -856
package/dist/docs/user-guide/_get-started/index.html ADDED
@@ -0,0 +1,602 @@
1
+
2
+ <!DOCTYPE html>
3
+
4
+ <html class="no-js" lang="en">
5
+ <head>
6
+ <meta charset="utf-8"/>
7
+ <meta content="width=device-width,initial-scale=1" name="viewport"/>
8
+ <link href="http://localhost:8000/docs/user-guide/_get-started/" rel="canonical"/>
9
+ <link href="../../operator-guide/texture-shade/" rel="prev"/>
10
+ <link href="../api-documentation/" rel="next"/>
11
+ <link href="../../assets/images/favicon.png" rel="icon"/>
12
+ <meta content="mkdocs-1.5.3, mkdocs-material-9.4.10" name="generator"/>
13
+ <title>Get started with LINZ Basemaps - LINZ Basemaps</title>
14
+ <link href="../../assets/stylesheets/main.fad675c6.min.css" rel="stylesheet"/>
15
+ <link href="../../assets/stylesheets/palette.356b1318.min.css" rel="stylesheet"/>
16
+ <link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
17
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i%7COpen+Sans+Mono:400,400i,700,700i&amp;display=fallback" rel="stylesheet"/>
18
+ <style>:root{--md-text-font:"Open Sans";--md-code-font:"Open Sans Mono"}</style>
19
+ <link href="../../index.css" rel="stylesheet"/>
20
+ <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>
21
+ <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>
22
+ <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
23
+ </head>
24
+ <body data-md-color-accent="indigo" data-md-color-primary="indigo" data-md-color-scheme="default" dir="ltr">
25
+ <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>
26
+ <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
27
+ <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
28
+ <label class="md-overlay" for="__drawer"></label>
29
+ <div data-md-component="skip">
30
+ <a class="md-skip" href="#get-started-with-linz-basemaps">
31
+ Skip to content
32
+ </a>
33
+ </div>
34
+ <div data-md-component="announce">
35
+ </div>
36
+ <header class="md-header md-header--shadow" data-md-component="header">
37
+ <nav aria-label="Header" class="md-header__inner md-grid">
38
+ <a aria-label="LINZ Basemaps" class="md-header__button md-logo" data-md-component="logo" href="../.." title="LINZ Basemaps">
39
+ <img alt="logo" src="../../linz-motif.svg"/>
40
+ </a>
41
+ <label class="md-header__button md-icon" for="__drawer">
42
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"></path></svg>
43
+ </label>
44
+ <div class="md-header__title" data-md-component="header-title">
45
+ <div class="md-header__ellipsis">
46
+ <div class="md-header__topic">
47
+ <span class="md-ellipsis">
48
+ LINZ Basemaps
49
+ </span>
50
+ </div>
51
+ <div class="md-header__topic" data-md-component="header-topic">
52
+ <span class="md-ellipsis">
53
+
54
+ Get started with LINZ Basemaps
55
+
56
+ </span>
57
+ </div>
58
+ </div>
59
+ </div>
60
+ <form class="md-header__option" data-md-component="palette">
61
+ <input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: light)" data-md-color-primary="indigo" data-md-color-scheme="default" id="__palette_1" name="__palette" type="radio"/>
62
+ <label class="md-header__button md-icon" for="__palette_2" hidden="" title="Switch to dark mode">
63
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><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"></path></svg>
64
+ </label>
65
+ <input aria-label="Switch to light mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-primary="indigo" data-md-color-scheme="slate" id="__palette_2" name="__palette" type="radio"/>
66
+ <label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to light mode">
67
+ <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><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"></path></svg>
68
+ </label>
69
+ </form>
70
+ <div class="md-header__source">
71
+ <a class="md-source" data-md-component="source" href="https://github.com/linz/basemaps" title="Go to repository">
72
+ <div class="md-source__icon md-icon">
73
+ <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! 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"></path></svg>
74
+ </div>
75
+ <div class="md-source__repository">
76
+ GitHub
77
+ </div>
78
+ </a>
79
+ </div>
80
+ </nav>
81
+ </header>
82
+ <div class="md-container" data-md-component="container">
83
+ <main class="md-main" data-md-component="main">
84
+ <div class="md-main__inner md-grid">
85
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
86
+ <div class="md-sidebar__scrollwrap">
87
+ <div class="md-sidebar__inner">
88
+ <nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">
89
+ <label class="md-nav__title" for="__drawer">
90
+ <a aria-label="LINZ Basemaps" class="md-nav__button md-logo" data-md-component="logo" href="../.." title="LINZ Basemaps">
91
+ <img alt="logo" src="../../linz-motif.svg"/>
92
+ </a>
93
+ LINZ Basemaps
94
+ </label>
95
+ <div class="md-nav__source">
96
+ <a class="md-source" data-md-component="source" href="https://github.com/linz/basemaps" title="Go to repository">
97
+ <div class="md-source__icon md-icon">
98
+ <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! 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"></path></svg>
99
+ </div>
100
+ <div class="md-source__repository">
101
+ GitHub
102
+ </div>
103
+ </a>
104
+ </div>
105
+ <ul class="md-nav__list" data-md-scrollfix="">
106
+ <li class="md-nav__item">
107
+ <a class="md-nav__link" href="../..">
108
+ <span class="md-ellipsis">
109
+ LINZ Basemaps
110
+ </span>
111
+ </a>
112
+ </li>
113
+ <li class="md-nav__item">
114
+ <a class="md-nav__link" href="../../configuration/">
115
+ <span class="md-ellipsis">
116
+ Configuration
117
+ </span>
118
+ </a>
119
+ </li>
120
+ <li class="md-nav__item">
121
+ <a class="md-nav__link" href="../../deployment/">
122
+ <span class="md-ellipsis">
123
+ Deployment
124
+ </span>
125
+ </a>
126
+ </li>
127
+ <li class="md-nav__item">
128
+ <a class="md-nav__link" href="../../quick-start/">
129
+ <span class="md-ellipsis">
130
+ Quick start guide
131
+ </span>
132
+ </a>
133
+ </li>
134
+ <li class="md-nav__item md-nav__item--nested">
135
+ <input class="md-nav__toggle md-toggle" id="__nav_5" type="checkbox"/>
136
+ <div class="md-nav__link md-nav__container">
137
+ <a class="md-nav__link" href="../../developer-guide/">
138
+ <span class="md-ellipsis">
139
+ Developer guide
140
+ </span>
141
+ </a>
142
+ </div>
143
+ <nav aria-expanded="false" aria-labelledby="__nav_5_label" class="md-nav" data-md-level="1">
144
+ <label class="md-nav__title" for="__nav_5">
145
+ <span class="md-nav__icon md-icon"></span>
146
+ Developer guide
147
+ </label>
148
+ <ul class="md-nav__list" data-md-scrollfix="">
149
+ </ul>
150
+ </nav>
151
+ </li>
152
+ <li class="md-nav__item md-nav__item--nested">
153
+ <input class="md-nav__toggle md-toggle" id="__nav_6" type="checkbox"/>
154
+ <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
155
+ <span class="md-ellipsis">
156
+ Examples
157
+ </span>
158
+ <span class="md-nav__icon md-icon"></span>
159
+ </label>
160
+ <nav aria-expanded="false" aria-labelledby="__nav_6_label" class="md-nav" data-md-level="1">
161
+ <label class="md-nav__title" for="__nav_6">
162
+ <span class="md-nav__icon md-icon"></span>
163
+ Examples
164
+ </label>
165
+ <ul class="md-nav__list" data-md-scrollfix="">
166
+ <li class="md-nav__item">
167
+ <a class="md-nav__link" href="../../examples/_overview/">
168
+ <span class="md-ellipsis">
169
+ Overview
170
+ </span>
171
+ </a>
172
+ </li>
173
+ <li class="md-nav__item">
174
+ <a class="md-nav__link" href="../../examples/leaflet.xyz.3857/">
175
+ <span class="md-ellipsis">
176
+ Leaflet Raster Map
177
+ </span>
178
+ </a>
179
+ </li>
180
+ <li class="md-nav__item">
181
+ <a class="md-nav__link" href="../../examples/maplibre.opacity.3857/">
182
+ <span class="md-ellipsis">
183
+ Maplibre Opacity Slider
184
+ </span>
185
+ </a>
186
+ </li>
187
+ <li class="md-nav__item">
188
+ <a class="md-nav__link" href="../../examples/maplibre.vector.3857/">
189
+ <span class="md-ellipsis">
190
+ Maplibre Vector Map
191
+ </span>
192
+ </a>
193
+ </li>
194
+ </ul>
195
+ </nav>
196
+ </li>
197
+ <li class="md-nav__item md-nav__item--nested">
198
+ <input class="md-nav__toggle md-toggle" id="__nav_7" type="checkbox"/>
199
+ <div class="md-nav__link md-nav__container">
200
+ <a class="md-nav__link" href="../../operator-guide/">
201
+ <span class="md-ellipsis">
202
+ Operator guide
203
+ </span>
204
+ </a>
205
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
206
+ <span class="md-nav__icon md-icon"></span>
207
+ </label>
208
+ </div>
209
+ <nav aria-expanded="false" aria-labelledby="__nav_7_label" class="md-nav" data-md-level="1">
210
+ <label class="md-nav__title" for="__nav_7">
211
+ <span class="md-nav__icon md-icon"></span>
212
+ Operator guide
213
+ </label>
214
+ <ul class="md-nav__list" data-md-scrollfix="">
215
+ <li class="md-nav__item">
216
+ <a class="md-nav__link" href="../../operator-guide/cog-quality/">
217
+ <span class="md-ellipsis">
218
+ COG Quality
219
+ </span>
220
+ </a>
221
+ </li>
222
+ <li class="md-nav__item">
223
+ <a class="md-nav__link" href="../../operator-guide/empty-tiles/">
224
+ <span class="md-ellipsis">
225
+ Sparse Datasets and empty tiles
226
+ </span>
227
+ </a>
228
+ </li>
229
+ <li class="md-nav__item">
230
+ <a class="md-nav__link" href="../../operator-guide/gebco/">
231
+ <span class="md-ellipsis">
232
+ Gebco re-project to NZTM2000Quad cog file
233
+ </span>
234
+ </a>
235
+ </li>
236
+ <li class="md-nav__item">
237
+ <a class="md-nav__link" href="../../operator-guide/quick-start/">
238
+ <span class="md-ellipsis">
239
+ Running LINZ Basemaps - Quick Start
240
+ </span>
241
+ </a>
242
+ </li>
243
+ <li class="md-nav__item">
244
+ <a class="md-nav__link" href="../../operator-guide/relief-shade/">
245
+ <span class="md-ellipsis">
246
+ Relief shade
247
+ </span>
248
+ </a>
249
+ </li>
250
+ <li class="md-nav__item">
251
+ <a class="md-nav__link" href="../../operator-guide/texture-shade/">
252
+ <span class="md-ellipsis">
253
+ Texture shading
254
+ </span>
255
+ </a>
256
+ </li>
257
+ </ul>
258
+ </nav>
259
+ </li>
260
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
261
+ <input checked="" class="md-nav__toggle md-toggle" id="__nav_8" type="checkbox"/>
262
+ <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
263
+ <span class="md-ellipsis">
264
+ User guide
265
+ </span>
266
+ <span class="md-nav__icon md-icon"></span>
267
+ </label>
268
+ <nav aria-expanded="true" aria-labelledby="__nav_8_label" class="md-nav" data-md-level="1">
269
+ <label class="md-nav__title" for="__nav_8">
270
+ <span class="md-nav__icon md-icon"></span>
271
+ User guide
272
+ </label>
273
+ <ul class="md-nav__list" data-md-scrollfix="">
274
+ <li class="md-nav__item md-nav__item--active">
275
+ <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>
276
+ <label class="md-nav__link md-nav__link--active" for="__toc">
277
+ <span class="md-ellipsis">
278
+ Get started with LINZ Basemaps
279
+ </span>
280
+ <span class="md-nav__icon md-icon"></span>
281
+ </label>
282
+ <a class="md-nav__link md-nav__link--active" href="./">
283
+ <span class="md-ellipsis">
284
+ Get started with LINZ Basemaps
285
+ </span>
286
+ </a>
287
+ <nav aria-label="Table of contents" class="md-nav md-nav--secondary">
288
+ <label class="md-nav__title" for="__toc">
289
+ <span class="md-nav__icon md-icon"></span>
290
+ Table of contents
291
+ </label>
292
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
293
+ <li class="md-nav__item">
294
+ <a class="md-nav__link" href="#how-to-get-started-with-linz-basemaps-apis">
295
+ <span class="md-ellipsis">
296
+ How to get started with LINZ Basemaps APIs
297
+ </span>
298
+ </a>
299
+ </li>
300
+ <li class="md-nav__item">
301
+ <a class="md-nav__link" href="#basics-of-our-apis">
302
+ <span class="md-ellipsis">
303
+ Basics of our APIs
304
+ </span>
305
+ </a>
306
+ <nav aria-label="Basics of our APIs" class="md-nav">
307
+ <ul class="md-nav__list">
308
+ <li class="md-nav__item">
309
+ <a class="md-nav__link" href="#what-api-access-levels-are-available">
310
+ <span class="md-ellipsis">
311
+ What API access levels are available?
312
+ </span>
313
+ </a>
314
+ </li>
315
+ <li class="md-nav__item">
316
+ <a class="md-nav__link" href="#what-protocols-are-available">
317
+ <span class="md-ellipsis">
318
+ What protocols are available?
319
+ </span>
320
+ </a>
321
+ </li>
322
+ <li class="md-nav__item">
323
+ <a class="md-nav__link" href="#important-documentation">
324
+ <span class="md-ellipsis">
325
+ Important documentation
326
+ </span>
327
+ </a>
328
+ </li>
329
+ <li class="md-nav__item">
330
+ <a class="md-nav__link" href="#stay-informed">
331
+ <span class="md-ellipsis">
332
+ Stay informed
333
+ </span>
334
+ </a>
335
+ </li>
336
+ <li class="md-nav__item">
337
+ <a class="md-nav__link" href="#support-hours">
338
+ <span class="md-ellipsis">
339
+ Support hours
340
+ </span>
341
+ </a>
342
+ </li>
343
+ </ul>
344
+ </nav>
345
+ </li>
346
+ </ul>
347
+ </nav>
348
+ </li>
349
+ <li class="md-nav__item">
350
+ <a class="md-nav__link" href="../api-documentation/">
351
+ <span class="md-ellipsis">
352
+ API documentation
353
+ </span>
354
+ </a>
355
+ </li>
356
+ <li class="md-nav__item">
357
+ <a class="md-nav__link" href="../technical-documentation/">
358
+ <span class="md-ellipsis">
359
+ Technical documentation and specifications
360
+ </span>
361
+ </a>
362
+ </li>
363
+ </ul>
364
+ </nav>
365
+ </li>
366
+ </ul>
367
+ </nav>
368
+ </div>
369
+ </div>
370
+ </div>
371
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
372
+ <div class="md-sidebar__scrollwrap">
373
+ <div class="md-sidebar__inner">
374
+ <nav aria-label="Table of contents" class="md-nav md-nav--secondary">
375
+ <label class="md-nav__title" for="__toc">
376
+ <span class="md-nav__icon md-icon"></span>
377
+ Table of contents
378
+ </label>
379
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
380
+ <li class="md-nav__item">
381
+ <a class="md-nav__link" href="#how-to-get-started-with-linz-basemaps-apis">
382
+ <span class="md-ellipsis">
383
+ How to get started with LINZ Basemaps APIs
384
+ </span>
385
+ </a>
386
+ </li>
387
+ <li class="md-nav__item">
388
+ <a class="md-nav__link" href="#basics-of-our-apis">
389
+ <span class="md-ellipsis">
390
+ Basics of our APIs
391
+ </span>
392
+ </a>
393
+ <nav aria-label="Basics of our APIs" class="md-nav">
394
+ <ul class="md-nav__list">
395
+ <li class="md-nav__item">
396
+ <a class="md-nav__link" href="#what-api-access-levels-are-available">
397
+ <span class="md-ellipsis">
398
+ What API access levels are available?
399
+ </span>
400
+ </a>
401
+ </li>
402
+ <li class="md-nav__item">
403
+ <a class="md-nav__link" href="#what-protocols-are-available">
404
+ <span class="md-ellipsis">
405
+ What protocols are available?
406
+ </span>
407
+ </a>
408
+ </li>
409
+ <li class="md-nav__item">
410
+ <a class="md-nav__link" href="#important-documentation">
411
+ <span class="md-ellipsis">
412
+ Important documentation
413
+ </span>
414
+ </a>
415
+ </li>
416
+ <li class="md-nav__item">
417
+ <a class="md-nav__link" href="#stay-informed">
418
+ <span class="md-ellipsis">
419
+ Stay informed
420
+ </span>
421
+ </a>
422
+ </li>
423
+ <li class="md-nav__item">
424
+ <a class="md-nav__link" href="#support-hours">
425
+ <span class="md-ellipsis">
426
+ Support hours
427
+ </span>
428
+ </a>
429
+ </li>
430
+ </ul>
431
+ </nav>
432
+ </li>
433
+ </ul>
434
+ </nav>
435
+ </div>
436
+ </div>
437
+ </div>
438
+ <div class="md-content" data-md-component="content">
439
+ <article class="md-content__inner md-typeset">
440
+ <h1 id="get-started-with-linz-basemaps">Get started with LINZ Basemaps</h1>
441
+ <p>The LINZ Basemaps API lets you build your own New Zealand-centric maps for mobile, web and GIS apps. This page describes our APIs and what you need to do to use them successfully.</p>
442
+ <h2 id="how-to-get-started-with-linz-basemaps-apis">How to get started with LINZ Basemaps APIs</h2>
443
+ <p>We've made getting started with LINZ Basemaps APIs easy.</p>
444
+ <ol>
445
+ <li>Pick a <a href="https://basemaps.linz.govt.nz/">LINZ Basemaps product</a>.</li>
446
+ <li>Grab a map tile API url from the menu bar.</li>
447
+ <li>If you're a developer, email <a href="mailto:basemaps@linz.govt.nz">basemaps@linz.govt.nz</a> for developer access</li>
448
+ <li>Find the <a href="../technical-documentation/">Technical documentation</a> and <a href="../api-documentation/">API documentation</a>, legals and how to's that will help you get mapping successfully.</li>
449
+ </ol>
450
+ <h2 id="basics-of-our-apis">Basics of our APIs</h2>
451
+ <h3 id="what-api-access-levels-are-available">What API access levels are available?</h3>
452
+ <p>There are two access levels to our APIs, there is no charge for either access level.</p>
453
+ <table>
454
+ <thead>
455
+ <tr>
456
+ <th>Level</th>
457
+ <th>Description</th>
458
+ </tr>
459
+ </thead>
460
+ <tbody>
461
+ <tr>
462
+ <td>Standard access</td>
463
+ <td>Standard access allows quick access to our Basemap APIs without needing to register. This access is best suited for use of our APIs in internal apps</td>
464
+ </tr>
465
+ <tr>
466
+ <td>Developer access</td>
467
+ <td>Developer access allows integration of our Basemap APIs into high volume public mapping platforms. Contact us to register for a site restricted API key</td>
468
+ </tr>
469
+ </tbody>
470
+ </table>
471
+ <h3 id="what-protocols-are-available">What protocols are available?</h3>
472
+ <p>We support three common standards for web mapping.</p>
473
+ <table>
474
+ <thead>
475
+ <tr>
476
+ <th>Protocol</th>
477
+ <th>Description</th>
478
+ </tr>
479
+ </thead>
480
+ <tbody>
481
+ <tr>
482
+ <td>XYZ</td>
483
+ <td>Best suited for use in web and mobile mapping JavaScript clients</td>
484
+ </tr>
485
+ <tr>
486
+ <td>WMTS</td>
487
+ <td>Support for Open Geospatial Consortium Web Map Tile Services WMTS v1.0.0 for use in GIS apps</td>
488
+ </tr>
489
+ <tr>
490
+ <td>Vector tile map services</td>
491
+ <td>Support for StyleJSON version 8 for access to our styled web maps</td>
492
+ </tr>
493
+ </tbody>
494
+ </table>
495
+ <h3 id="important-documentation">Important documentation</h3>
496
+ <p>There are a few core concepts within our technical documentation that you should check out before you start mapping.</p>
497
+ <ul>
498
+ <li><a href="../technical-documentation/#api-access-levels">Access levels</a></li>
499
+ <li><a href="../technical-documentation/#rate-limiting">Rate limiting</a></li>
500
+ <li><a href="../technical-documentation/#response-codes">Response codes</a></li>
501
+ <li><a href="../technical-documentation/#data-attribution">Data attribution</a></li>
502
+ </ul>
503
+ <h3 id="stay-informed">Stay informed</h3>
504
+ <p>Contact us at <a href="mailto:basemaps@linz.govt.nz">basemaps@linz.govt.nz</a> to get email notifications related to LINZ Basemaps APIs, including announcements of new services or planned changes to APIs.</p>
505
+ <p>If you have registered for a Developer API then you do not need to sign up as you will already be included on the list.</p>
506
+ <h3 id="support-hours">Support hours</h3>
507
+ <p>Monday to Friday
508
+ 9:00am - 5:00pm
509
+ Closed on public holidays</p>
510
+ </article>
511
+ </div>
512
+ </div>
513
+ </main>
514
+ <footer class="md-footer">
515
+ <div class="md-footer-meta md-typeset">
516
+ <div class="md-footer-meta__inner md-grid">
517
+ <div class="md-copyright">
518
+ <div class="md-copyright__highlight">
519
+ <a href="https://www.linz.govt.nz/copyright">© CC BY 4.0 LINZ</a>
520
+ </div>
521
+
522
+
523
+ Made with
524
+ <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">
525
+ Material for MkDocs
526
+ </a>
527
+ </div>
528
+ </div>
529
+ </div>
530
+ </footer>
531
+ </div>
532
+ <div class="md-dialog" data-md-component="dialog">
533
+ <div class="md-dialog__inner md-typeset"></div>
534
+ </div>
535
+ <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>
536
+ <script src="../../assets/javascripts/bundle.6c14ae12.min.js"></script>
537
+ <script>document$.subscribe(() => {
538
+ window.update_swagger_ui_iframe_height = function (id) {
539
+ var iFrameID = document.getElementById(id);
540
+ if (iFrameID) {
541
+ full_height = (iFrameID.contentWindow.document.body.scrollHeight + 80) + "px";
542
+ iFrameID.height = full_height;
543
+ iFrameID.style.height = full_height;
544
+ }
545
+ }
546
+
547
+ let iframe_id_list = []
548
+ var iframes = document.getElementsByClassName("swagger-ui-iframe");
549
+ for (var i = 0; i < iframes.length; i++) {
550
+ iframe_id_list.push(iframes[i].getAttribute("id"))
551
+ }
552
+
553
+ let ticking = true;
554
+
555
+ document.addEventListener('scroll', function(e) {
556
+ if (!ticking) {
557
+ window.requestAnimationFrame(()=> {
558
+ let half_vh = window.innerHeight/2;
559
+ for(var i = 0; i < iframe_id_list.length; i++) {
560
+ let element = document.getElementById(iframe_id_list[i])
561
+ if(element==null){
562
+ return
563
+ }
564
+ let diff = element.getBoundingClientRect().top
565
+ if(element.contentWindow.update_top_val){
566
+ element.contentWindow.update_top_val(half_vh - diff)
567
+ }
568
+ }
569
+ ticking = false;
570
+ });
571
+ ticking = true;
572
+ }
573
+ });
574
+
575
+ const dark_scheme_name = "slate"
576
+
577
+ window.scheme = document.body.getAttribute("data-md-color-scheme")
578
+ const options = {
579
+ attributeFilter: ['data-md-color-scheme'],
580
+ };
581
+ function color_scheme_callback(mutations) {
582
+ for (let mutation of mutations) {
583
+ if (mutation.attributeName === "data-md-color-scheme") {
584
+ scheme = document.body.getAttribute("data-md-color-scheme")
585
+ var iframe_list = document.getElementsByClassName("swagger-ui-iframe")
586
+ for(var i = 0; i < iframe_list.length; i++) {
587
+ var ele = iframe_list.item(i);
588
+ if (ele) {
589
+ if (scheme === dark_scheme_name) {
590
+ ele.contentWindow.enable_dark_mode();
591
+ } else {
592
+ ele.contentWindow.disable_dark_mode();
593
+ }
594
+ }
595
+ }
596
+ }
597
+ }
598
+ }
599
+ observer = new MutationObserver(color_scheme_callback);
600
+ observer.observe(document.body, options);
601
+ })</script></body>
602
+ </html>