@maptiler/client 1.0.2 → 1.1.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.
- package/.github/workflows/npm-publish.yml +0 -1
- package/dist/maptiler-client.cjs +465 -21
- package/dist/maptiler-client.cjs.map +1 -1
- package/dist/maptiler-client.d.ts +395 -2
- package/dist/maptiler-client.min.mjs +1 -1
- package/dist/maptiler-client.mjs +461 -22
- package/dist/maptiler-client.mjs.map +1 -1
- package/dist/maptiler-client.umd.js +465 -21
- package/dist/maptiler-client.umd.js.map +1 -1
- package/dist/maptiler-client.umd.min.js +1 -1
- package/docs/assets/custom.css +118 -0
- package/docs/assets/highlight.css +10 -10
- package/docs/assets/main.js +56 -52
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +23 -0
- package/docs/classes/{ClientConfig.html → config.ClientConfig.html} +34 -24
- package/docs/classes/{ServiceError.html → services_ServiceError.ServiceError.html} +26 -16
- package/docs/functions/language.getAutoLanguageGeocoding.html +60 -0
- package/docs/functions/services_simplify.default.html +65 -0
- package/docs/images/maptiler-logo-256.png +0 -0
- package/docs/index.html +118 -57
- package/docs/modules/config.html +71 -0
- package/docs/modules/language.html +71 -0
- package/docs/modules/services_ServiceError.html +61 -0
- package/docs/modules/services_coordinates.html +84 -0
- package/docs/modules/services_data.html +66 -0
- package/docs/modules/services_geocoding.html +76 -0
- package/docs/modules/services_geolocation.html +68 -0
- package/docs/modules/services_simplify.html +61 -0
- package/docs/modules/services_staticMaps.html +74 -0
- package/docs/modules.html +23 -83
- package/docs/types/config.FetchFunction.html +71 -0
- package/docs/types/language.LanguageGeocodingString.html +58 -0
- package/docs/types/services_coordinates.CoordinateExport.html +71 -0
- package/docs/types/services_coordinates.CoordinateGrid.html +69 -0
- package/docs/types/services_coordinates.CoordinateId.html +71 -0
- package/docs/types/services_coordinates.CoordinateSearch.html +93 -0
- package/docs/types/services_coordinates.CoordinateSearchResult.html +75 -0
- package/docs/types/services_coordinates.CoordinateTransformResult.html +76 -0
- package/docs/types/services_coordinates.CoordinateTransformation.html +89 -0
- package/docs/types/services_coordinates.CoordinatesSearchOptions.html +83 -0
- package/docs/types/services_coordinates.CoordinatesTransformOptions.html +85 -0
- package/docs/types/services_coordinates.XYZ.html +73 -0
- package/docs/types/services_data.GetDataOptions.html +64 -0
- package/docs/types/services_geocoding.Coordinates.html +60 -0
- package/docs/types/services_geocoding.FeatureHierarchy.html +71 -0
- package/docs/types/services_geocoding.GeocodingFeature.html +60 -0
- package/docs/types/services_geocoding.GeocodingOptions.html +79 -0
- package/docs/types/services_geocoding.GeocodingSearchResult.html +77 -0
- package/docs/types/services_geocoding.ReverseGeocodingOptions.html +71 -0
- package/docs/types/services_geolocation.GeolocationInfoOptions.html +65 -0
- package/docs/types/services_geolocation.GeolocationResult.html +128 -0
- package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +61 -0
- package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +61 -0
- package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +61 -0
- package/docs/types/{StaticMapBaseOptions.html → services_staticMaps.StaticMapBaseOptions.html} +26 -45
- package/docs/types/services_staticMaps.StaticMapMarker.html +61 -0
- package/docs/variables/config.config.html +58 -0
- package/docs/variables/{LanguageGeocoding.html → language.LanguageGeocoding.html} +20 -42
- package/docs/variables/services_coordinates.coordinates.html +110 -0
- package/docs/variables/services_data.data.html +80 -0
- package/docs/variables/{geocoding.html → services_geocoding.geocoding.html} +35 -53
- package/docs/variables/services_geolocation.geolocation.html +79 -0
- package/docs/variables/services_staticMaps.staticMaps.html +128 -0
- package/docsmd/README.md +143 -36
- package/docsmd/assets/custom.css +118 -0
- package/docsmd/classes/ClientConfig.md +5 -5
- package/docsmd/classes/MapStyleVariant.md +217 -0
- package/docsmd/classes/ReferenceMapStyle.md +169 -0
- package/docsmd/classes/ServiceError.md +3 -3
- package/examples/test-browser-umd.html +1 -1
- package/images/maptiler-logo-256.png +0 -0
- package/package.json +5 -5
- package/readme.md +65 -5
- package/src/index.ts +17 -0
- package/src/mapstyle.ts +841 -0
- package/src/services/staticMaps.ts +5 -4
- package/tsconfig.json +0 -1
- package/typedoc.css +118 -0
- package/typedoc.json +7 -3
- package/docs/types/AutomaticStaticMapOptions.html +0 -80
- package/docs/types/BoundedStaticMapOptions.html +0 -80
- package/docs/types/CenteredStaticMapOptions.html +0 -80
- package/docs/types/CoordinateExport.html +0 -85
- package/docs/types/CoordinateGrid.html +0 -83
- package/docs/types/CoordinateId.html +0 -85
- package/docs/types/CoordinateSearch.html +0 -107
- package/docs/types/CoordinateSearchResult.html +0 -89
- package/docs/types/CoordinateTransformResult.html +0 -90
- package/docs/types/CoordinateTransformation.html +0 -103
- package/docs/types/Coordinates.html +0 -78
- package/docs/types/CoordinatesSearchOptions.html +0 -97
- package/docs/types/CoordinatesTransformOptions.html +0 -99
- package/docs/types/FeatureHierarchy.html +0 -89
- package/docs/types/FetchFunction.html +0 -93
- package/docs/types/GeocodingFeature.html +0 -78
- package/docs/types/GeocodingOptions.html +0 -97
- package/docs/types/GeocodingSearchResult.html +0 -95
- package/docs/types/GeolocationInfoOptions.html +0 -87
- package/docs/types/GeolocationResult.html +0 -150
- package/docs/types/GetDataOptions.html +0 -87
- package/docs/types/LanguageGeocodingString.html +0 -80
- package/docs/types/ReverseGeocodingOptions.html +0 -89
- package/docs/types/StaticMapMarker.html +0 -80
- package/docs/types/XYZ.html +0 -87
- package/docs/variables/config.html +0 -80
- package/docs/variables/coordinates-1.html +0 -124
- package/docs/variables/data.html +0 -103
- package/docs/variables/geolocation.html +0 -101
- package/docs/variables/staticMaps.html +0 -147
- package/docsmd/images/JS-logo.svg +0 -4
- package/docsmd/images/TS-logo.svg +0 -6
- package/docsmd/images/maptiler-client-logo.afdesign +0 -0
- package/docsmd/images/maptiler-client-logo.svg +0 -75
- package/docsmd/images/maptiler-logo.svg +0 -23
- package/docsmd/images/screenshots/static-bounded-europe-1024.png +0 -0
- package/docsmd/images/screenshots/static-bounded-europe-2048.png +0 -0
- package/docsmd/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
- package/docsmd/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
- package/docsmd/images/screenshots/static-with-path.png +0 -0
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>staticMaps | MapTiler Client - v1.1.0</title><meta name="description" content="Documentation for MapTiler Client - v1.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">MapTiler Client - v1.1.0</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-8 col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">MapTiler Client - v1.1.0</a></li>
|
|
16
|
+
<li><a href="../modules/services_staticMaps.html">services/staticMaps</a></li>
|
|
17
|
+
<li><a href="services_staticMaps.staticMaps.html">staticMaps</a></li></ul>
|
|
18
|
+
<h1>Variable staticMaps<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
|
|
19
|
+
<div class="tsd-signature">static<wbr/>Maps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>automatic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span>bounded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>boundingBox<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BBox</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span>centered<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, zoom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.StaticMapBaseOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">StaticMapBaseOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
20
|
+
<div class="tsd-comment tsd-typography"><p>The <strong>staticMaps</strong> namespace contains an synchronous function build image URL of static map, as specified by the <a href="https://docs.maptiler.com/cloud/api/static-maps/">MapTiler Static Map API</a>.
|
|
21
|
+
The URL of static maps can then be used within a <code><img /></code> markup element, as the <code>src</code> property value.</p>
|
|
22
|
+
</div>
|
|
23
|
+
<div class="tsd-type-declaration">
|
|
24
|
+
<h4>Type declaration</h4>
|
|
25
|
+
<ul class="tsd-parameters">
|
|
26
|
+
<li class="tsd-parameter">
|
|
27
|
+
<h5>automatic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
|
|
28
|
+
<ul class="tsd-parameters">
|
|
29
|
+
<li class="tsd-parameter-signature">
|
|
30
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
31
|
+
<li class="tsd-signature" id="__type.automatic.__type-1.__type-2"><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
32
|
+
<li class="tsd-description">
|
|
33
|
+
<div class="tsd-comment tsd-typography"><p>Construct the URL for a static map automatically fitted around the provided path or markers.
|
|
34
|
+
Note: this function does not fetch the binary content of the image since
|
|
35
|
+
the purpose of a static map is generally to have its URL as a <code>src</code> property of a <img/> element.
|
|
36
|
+
If a path is provided and is too long, it will be simplified in an accurate way.</p>
|
|
37
|
+
|
|
38
|
+
<h3>Returns</h3></div>
|
|
39
|
+
<div class="tsd-parameters">
|
|
40
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
41
|
+
<ul class="tsd-parameter-list">
|
|
42
|
+
<li>
|
|
43
|
+
<h5>options: <a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
44
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></li>
|
|
45
|
+
<li class="tsd-parameter">
|
|
46
|
+
<h5>bounded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>boundingBox<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BBox</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
|
|
47
|
+
<ul class="tsd-parameters">
|
|
48
|
+
<li class="tsd-parameter-signature">
|
|
49
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
50
|
+
<li class="tsd-signature" id="__type.bounded.__type-3.__type-4"><span class="tsd-signature-symbol">(</span>boundingBox<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BBox</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
51
|
+
<li class="tsd-description">
|
|
52
|
+
<div class="tsd-comment tsd-typography"><p>Construct the URL for a static map using a bounding box
|
|
53
|
+
Note: this function does not fetch the binary content of the image since
|
|
54
|
+
the purpose of a static map is generally to have its URL as a <code>src</code> property of a <img/> element.
|
|
55
|
+
If a path is provided and is too long, it will be simplified in an accurate way.</p>
|
|
56
|
+
|
|
57
|
+
<h3>Returns</h3></div>
|
|
58
|
+
<div class="tsd-parameters">
|
|
59
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
60
|
+
<ul class="tsd-parameter-list">
|
|
61
|
+
<li>
|
|
62
|
+
<h5>boundingBox: <span class="tsd-signature-type">BBox</span></h5></li>
|
|
63
|
+
<li>
|
|
64
|
+
<h5>options: <a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">BoundedStaticMapOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
65
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></li>
|
|
66
|
+
<li class="tsd-parameter">
|
|
67
|
+
<h5>centered<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, zoom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.StaticMapBaseOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">StaticMapBaseOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
|
|
68
|
+
<ul class="tsd-parameters">
|
|
69
|
+
<li class="tsd-parameter-signature">
|
|
70
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
71
|
+
<li class="tsd-signature" id="__type.centered.__type-5.__type-6"><span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, zoom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_staticMaps.StaticMapBaseOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">StaticMapBaseOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
72
|
+
<li class="tsd-description">
|
|
73
|
+
<div class="tsd-comment tsd-typography"><p>Construct the URL for a static map centered on one point.
|
|
74
|
+
Note: this function does not fetch the binary content of the image since
|
|
75
|
+
the purpose of a static map is generally to have its URL as a <code>src</code> property of a <img/> element.
|
|
76
|
+
If a path is provided and is too long, it will be simplified in an accurate way.</p>
|
|
77
|
+
|
|
78
|
+
<h3>Returns</h3></div>
|
|
79
|
+
<div class="tsd-parameters">
|
|
80
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
81
|
+
<ul class="tsd-parameter-list">
|
|
82
|
+
<li>
|
|
83
|
+
<h5>center: <span class="tsd-signature-type">Position</span></h5></li>
|
|
84
|
+
<li>
|
|
85
|
+
<h5>zoom: <span class="tsd-signature-type">number</span></h5></li>
|
|
86
|
+
<li>
|
|
87
|
+
<h5>options: <a href="../types/services_staticMaps.StaticMapBaseOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">StaticMapBaseOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
88
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Defined in <a href="https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L457">services/staticMaps.ts:457</a></li></ul></aside></div>
|
|
91
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
92
|
+
<div class="tsd-navigation settings">
|
|
93
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
94
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
95
|
+
<div class="tsd-accordion-details">
|
|
96
|
+
<div class="tsd-filter-visibility">
|
|
97
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
98
|
+
<ul id="tsd-filter-options">
|
|
99
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
|
|
100
|
+
<div class="tsd-theme-toggle">
|
|
101
|
+
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
102
|
+
<nav class="tsd-navigation primary">
|
|
103
|
+
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
104
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
105
|
+
<div class="tsd-accordion-details">
|
|
106
|
+
<ul>
|
|
107
|
+
<li class="current"><a href="../modules.html">Map<wbr/>Tiler <wbr/>Client -<wbr/> v1.1.0</a>
|
|
108
|
+
<ul>
|
|
109
|
+
<li class="tsd-kind-module"><a href="../modules/config.html">config</a></li>
|
|
110
|
+
<li class="tsd-kind-module"><a href="../modules/language.html">language</a></li>
|
|
111
|
+
<li class="tsd-kind-module"><a href="../modules/services_ServiceError.html">services/<wbr/>Service<wbr/>Error</a></li>
|
|
112
|
+
<li class="tsd-kind-module"><a href="../modules/services_coordinates.html">services/coordinates</a></li>
|
|
113
|
+
<li class="tsd-kind-module"><a href="../modules/services_data.html">services/data</a></li>
|
|
114
|
+
<li class="tsd-kind-module"><a href="../modules/services_geocoding.html">services/geocoding</a></li>
|
|
115
|
+
<li class="tsd-kind-module"><a href="../modules/services_geolocation.html">services/geolocation</a></li>
|
|
116
|
+
<li class="tsd-kind-module"><a href="../modules/services_simplify.html">services/simplify</a></li>
|
|
117
|
+
<li class="current tsd-kind-module"><a href="../modules/services_staticMaps.html">services/static<wbr/>Maps</a></li></ul></li></ul></div></details></nav>
|
|
118
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
119
|
+
<ul>
|
|
120
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_staticMaps.AutomaticStaticMapOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Automatic<wbr/>Static<wbr/>Map<wbr/>Options</a></li>
|
|
121
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_staticMaps.BoundedStaticMapOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Bounded<wbr/>Static<wbr/>Map<wbr/>Options</a></li>
|
|
122
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_staticMaps.CenteredStaticMapOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Centered<wbr/>Static<wbr/>Map<wbr/>Options</a></li>
|
|
123
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_staticMaps.StaticMapBaseOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Static<wbr/>Map<wbr/>Base<wbr/>Options</a></li>
|
|
124
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_staticMaps.StaticMapMarker.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Static<wbr/>Map<wbr/>Marker</a></li>
|
|
125
|
+
<li class="current tsd-kind-variable tsd-parent-kind-module"><a href="services_staticMaps.staticMaps.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>static<wbr/>Maps</a></li></ul></nav></div></div>
|
|
126
|
+
<div class="container tsd-generator">
|
|
127
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
128
|
+
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
package/docsmd/README.md
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
|
-
MapTiler Client
|
|
1
|
+
MapTiler Client - v1.1.0
|
|
2
2
|
|
|
3
|
-
# MapTiler Client
|
|
3
|
+
# MapTiler Client - v1.1.0
|
|
4
4
|
|
|
5
5
|
## Table of contents
|
|
6
6
|
|
|
7
7
|
### Classes
|
|
8
8
|
|
|
9
9
|
- [ClientConfig](classes/ClientConfig.md)
|
|
10
|
+
- [MapStyleVariant](classes/MapStyleVariant.md)
|
|
11
|
+
- [ReferenceMapStyle](classes/ReferenceMapStyle.md)
|
|
10
12
|
- [ServiceError](classes/ServiceError.md)
|
|
11
13
|
|
|
12
14
|
### Type Aliases
|
|
@@ -33,6 +35,8 @@ MapTiler Client JS
|
|
|
33
35
|
- [GeolocationResult](README.md#geolocationresult)
|
|
34
36
|
- [GetDataOptions](README.md#getdataoptions)
|
|
35
37
|
- [LanguageGeocodingString](README.md#languagegeocodingstring)
|
|
38
|
+
- [MapStylePreset](README.md#mapstylepreset)
|
|
39
|
+
- [MapStyleType](README.md#mapstyletype)
|
|
36
40
|
- [ReverseGeocodingOptions](README.md#reversegeocodingoptions)
|
|
37
41
|
- [StaticMapBaseOptions](README.md#staticmapbaseoptions)
|
|
38
42
|
- [StaticMapMarker](README.md#staticmapmarker)
|
|
@@ -41,13 +45,19 @@ MapTiler Client JS
|
|
|
41
45
|
### Variables
|
|
42
46
|
|
|
43
47
|
- [LanguageGeocoding](README.md#languagegeocoding)
|
|
48
|
+
- [MapStyle](README.md#mapstyle)
|
|
44
49
|
- [config](README.md#config)
|
|
45
50
|
- [coordinates](README.md#coordinates-1)
|
|
46
51
|
- [data](README.md#data)
|
|
47
52
|
- [geocoding](README.md#geocoding)
|
|
48
53
|
- [geolocation](README.md#geolocation)
|
|
54
|
+
- [mapStylePresetList](README.md#mapstylepresetlist)
|
|
49
55
|
- [staticMaps](README.md#staticmaps)
|
|
50
56
|
|
|
57
|
+
### Functions
|
|
58
|
+
|
|
59
|
+
- [styleToStyle](README.md#styletostyle)
|
|
60
|
+
|
|
51
61
|
## Type Aliases
|
|
52
62
|
|
|
53
63
|
### AutomaticStaticMapOptions
|
|
@@ -58,7 +68,7 @@ Options that can be provided to automatic static maps
|
|
|
58
68
|
|
|
59
69
|
#### Defined in
|
|
60
70
|
|
|
61
|
-
[services/staticMaps.ts:
|
|
71
|
+
[services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L141)
|
|
62
72
|
|
|
63
73
|
___
|
|
64
74
|
|
|
@@ -70,7 +80,7 @@ Options that can be provided to bounded static maps
|
|
|
70
80
|
|
|
71
81
|
#### Defined in
|
|
72
82
|
|
|
73
|
-
[services/staticMaps.ts:
|
|
83
|
+
[services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L130)
|
|
74
84
|
|
|
75
85
|
___
|
|
76
86
|
|
|
@@ -82,7 +92,7 @@ Options that can be provided to centered static maps
|
|
|
82
92
|
|
|
83
93
|
#### Defined in
|
|
84
94
|
|
|
85
|
-
[services/staticMaps.ts:
|
|
95
|
+
[services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L125)
|
|
86
96
|
|
|
87
97
|
___
|
|
88
98
|
|
|
@@ -99,7 +109,7 @@ ___
|
|
|
99
109
|
|
|
100
110
|
#### Defined in
|
|
101
111
|
|
|
102
|
-
[services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/
|
|
112
|
+
[services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L38)
|
|
103
113
|
|
|
104
114
|
___
|
|
105
115
|
|
|
@@ -115,7 +125,7 @@ ___
|
|
|
115
125
|
|
|
116
126
|
#### Defined in
|
|
117
127
|
|
|
118
|
-
[services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/
|
|
128
|
+
[services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L43)
|
|
119
129
|
|
|
120
130
|
___
|
|
121
131
|
|
|
@@ -132,7 +142,7 @@ ___
|
|
|
132
142
|
|
|
133
143
|
#### Defined in
|
|
134
144
|
|
|
135
|
-
[services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/
|
|
145
|
+
[services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L33)
|
|
136
146
|
|
|
137
147
|
___
|
|
138
148
|
|
|
@@ -158,7 +168,7 @@ ___
|
|
|
158
168
|
|
|
159
169
|
#### Defined in
|
|
160
170
|
|
|
161
|
-
[services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/
|
|
171
|
+
[services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L61)
|
|
162
172
|
|
|
163
173
|
___
|
|
164
174
|
|
|
@@ -175,7 +185,7 @@ ___
|
|
|
175
185
|
|
|
176
186
|
#### Defined in
|
|
177
187
|
|
|
178
|
-
[services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/
|
|
188
|
+
[services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L91)
|
|
179
189
|
|
|
180
190
|
___
|
|
181
191
|
|
|
@@ -192,7 +202,7 @@ ___
|
|
|
192
202
|
|
|
193
203
|
#### Defined in
|
|
194
204
|
|
|
195
|
-
[services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/
|
|
205
|
+
[services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L159)
|
|
196
206
|
|
|
197
207
|
___
|
|
198
208
|
|
|
@@ -218,7 +228,7 @@ ___
|
|
|
218
228
|
|
|
219
229
|
#### Defined in
|
|
220
230
|
|
|
221
|
-
[services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/
|
|
231
|
+
[services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L47)
|
|
222
232
|
|
|
223
233
|
___
|
|
224
234
|
|
|
@@ -228,7 +238,7 @@ ___
|
|
|
228
238
|
|
|
229
239
|
#### Defined in
|
|
230
240
|
|
|
231
|
-
[services/geocoding.ts:40](https://github.com/maptiler/maptiler-client-js/blob/
|
|
241
|
+
[services/geocoding.ts:40](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L40)
|
|
232
242
|
|
|
233
243
|
___
|
|
234
244
|
|
|
@@ -247,7 +257,7 @@ ___
|
|
|
247
257
|
|
|
248
258
|
#### Defined in
|
|
249
259
|
|
|
250
|
-
[services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/
|
|
260
|
+
[services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L11)
|
|
251
261
|
|
|
252
262
|
___
|
|
253
263
|
|
|
@@ -268,7 +278,7 @@ Options that can be provided when transforming a coordinate from one CRS to anot
|
|
|
268
278
|
|
|
269
279
|
#### Defined in
|
|
270
280
|
|
|
271
|
-
[services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/
|
|
281
|
+
[services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L174)
|
|
272
282
|
|
|
273
283
|
___
|
|
274
284
|
|
|
@@ -285,7 +295,7 @@ ___
|
|
|
285
295
|
|
|
286
296
|
#### Defined in
|
|
287
297
|
|
|
288
|
-
[services/geocoding.ts:42](https://github.com/maptiler/maptiler-client-js/blob/
|
|
298
|
+
[services/geocoding.ts:42](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L42)
|
|
289
299
|
|
|
290
300
|
___
|
|
291
301
|
|
|
@@ -310,7 +320,7 @@ ___
|
|
|
310
320
|
|
|
311
321
|
#### Defined in
|
|
312
322
|
|
|
313
|
-
[config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/
|
|
323
|
+
[config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/config.ts#L1)
|
|
314
324
|
|
|
315
325
|
___
|
|
316
326
|
|
|
@@ -320,7 +330,7 @@ ___
|
|
|
320
330
|
|
|
321
331
|
#### Defined in
|
|
322
332
|
|
|
323
|
-
[services/geocoding.ts:54](https://github.com/maptiler/maptiler-client-js/blob/
|
|
333
|
+
[services/geocoding.ts:54](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L54)
|
|
324
334
|
|
|
325
335
|
___
|
|
326
336
|
|
|
@@ -339,7 +349,7 @@ ___
|
|
|
339
349
|
|
|
340
350
|
#### Defined in
|
|
341
351
|
|
|
342
|
-
[services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/
|
|
352
|
+
[services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L18)
|
|
343
353
|
|
|
344
354
|
___
|
|
345
355
|
|
|
@@ -358,7 +368,7 @@ ___
|
|
|
358
368
|
|
|
359
369
|
#### Defined in
|
|
360
370
|
|
|
361
|
-
[services/geocoding.ts:86](https://github.com/maptiler/maptiler-client-js/blob/
|
|
371
|
+
[services/geocoding.ts:86](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L86)
|
|
362
372
|
|
|
363
373
|
___
|
|
364
374
|
|
|
@@ -376,7 +386,7 @@ Options that can be provided to get user data.
|
|
|
376
386
|
|
|
377
387
|
#### Defined in
|
|
378
388
|
|
|
379
|
-
[services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/
|
|
389
|
+
[services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geolocation.ts#L14)
|
|
380
390
|
|
|
381
391
|
___
|
|
382
392
|
|
|
@@ -405,7 +415,7 @@ ___
|
|
|
405
415
|
|
|
406
416
|
#### Defined in
|
|
407
417
|
|
|
408
|
-
[services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/
|
|
418
|
+
[services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geolocation.ts#L21)
|
|
409
419
|
|
|
410
420
|
___
|
|
411
421
|
|
|
@@ -423,7 +433,7 @@ Options that can be provided to get user data.
|
|
|
423
433
|
|
|
424
434
|
#### Defined in
|
|
425
435
|
|
|
426
|
-
[services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/
|
|
436
|
+
[services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/data.ts#L14)
|
|
427
437
|
|
|
428
438
|
___
|
|
429
439
|
|
|
@@ -435,7 +445,58 @@ Built-in languages values as strings
|
|
|
435
445
|
|
|
436
446
|
#### Defined in
|
|
437
447
|
|
|
438
|
-
[language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/
|
|
448
|
+
[language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/language.ts#L69)
|
|
449
|
+
|
|
450
|
+
___
|
|
451
|
+
|
|
452
|
+
### MapStylePreset
|
|
453
|
+
|
|
454
|
+
Ƭ **MapStylePreset**: `Object`
|
|
455
|
+
|
|
456
|
+
Type for object containing style details
|
|
457
|
+
|
|
458
|
+
#### Type declaration
|
|
459
|
+
|
|
460
|
+
| Name | Type |
|
|
461
|
+
| :------ | :------ |
|
|
462
|
+
| `description` | `string` |
|
|
463
|
+
| `name` | `string` |
|
|
464
|
+
| `referenceStyleID` | `string` |
|
|
465
|
+
| `variants` | { `description`: `string` ; `id`: `string` ; `imageURL`: `string` ; `name`: `string` ; `variantType`: `string` }[] |
|
|
466
|
+
|
|
467
|
+
#### Defined in
|
|
468
|
+
|
|
469
|
+
[mapstyle.ts:4](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/mapstyle.ts#L4)
|
|
470
|
+
|
|
471
|
+
___
|
|
472
|
+
|
|
473
|
+
### MapStyleType
|
|
474
|
+
|
|
475
|
+
Ƭ **MapStyleType**: `Object`
|
|
476
|
+
|
|
477
|
+
All the styles and variants maintained by MapTiler.
|
|
478
|
+
|
|
479
|
+
#### Type declaration
|
|
480
|
+
|
|
481
|
+
| Name | Type | Description |
|
|
482
|
+
| :------ | :------ | :------ |
|
|
483
|
+
| `BASIC` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A minimalist street-oriented style without POI |
|
|
484
|
+
| `BRIGHT` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A bright street-oriented style, a nice alternative to `streets` |
|
|
485
|
+
| `HYBRID` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery with labels, political borders and roads. |
|
|
486
|
+
| `OCEAN` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Explore deep see trenches and mountains, with isolines and depth labels |
|
|
487
|
+
| `OPENSTREETMAP` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Classic OpenStreetMap style |
|
|
488
|
+
| `OUTDOOR` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for outdoor activities. With elevation isolines and hillshading. |
|
|
489
|
+
| `SATELLITE` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery only, without any label. |
|
|
490
|
+
| `STAGE` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Minimalist style, perfect for data visualization |
|
|
491
|
+
| `STREETS` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings |
|
|
492
|
+
| `TONER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `BACKGROUND`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LINES`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LITE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A bold very high contrast black and white (no gray!) style for the city |
|
|
493
|
+
| `TOPO` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `SHINY`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `TOPOGRAPHIQUE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A nice high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details |
|
|
494
|
+
| `VOYAGER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `VINTAGE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A nice alternative to `streets` with a soft color palette |
|
|
495
|
+
| `WINTER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading. |
|
|
496
|
+
|
|
497
|
+
#### Defined in
|
|
498
|
+
|
|
499
|
+
[mapstyle.ts:225](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/mapstyle.ts#L225)
|
|
439
500
|
|
|
440
501
|
___
|
|
441
502
|
|
|
@@ -452,7 +513,7 @@ ___
|
|
|
452
513
|
|
|
453
514
|
#### Defined in
|
|
454
515
|
|
|
455
|
-
[services/geocoding.ts:165](https://github.com/maptiler/maptiler-client-js/blob/
|
|
516
|
+
[services/geocoding.ts:165](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L165)
|
|
456
517
|
|
|
457
518
|
___
|
|
458
519
|
|
|
@@ -478,12 +539,12 @@ Base set of options that can be provided to all the types of static maps
|
|
|
478
539
|
| `pathFillColor?` | `string` | Color of the filling, also works if the polygon is not closed. The color must be CSS compatible. Examples: - long form hex without transparency `"#FF0000"` (red) - short form hex without transparency `"#F00"` (red) - long form hex with transparency `"#FF000008"` (red, half opacity) - short form hex with transparency `"#F008"` (red, half opacity) - CSS color shorthands: `"red"`, `"chartreuse"`, etc. - decimal RGB values without transparency: `"rgb(128, 100, 255)"` - decimal RGB values with transparency: `"rgb(128, 100, 255, 0.5)"` Default: none (transparent filling) |
|
|
479
540
|
| `pathStrokeColor?` | `string` | Color of the path line. The color must be CSS compatible. Examples: - long form hex without transparency `"#FF0000"` (red) - short form hex without transparency `"#F00"` (red) - long form hex with transparency `"#FF000008"` (red, half opacity) - short form hex with transparency `"#F008"` (red, half opacity) - CSS color shorthands: `"red"`, `"chartreuse"`, etc. - decimal RGB values without transparency: `"rgb(128, 100, 255)"` - decimal RGB values with transparency: `"rgb(128, 100, 255, 0.5)"` Default: `"blue"` |
|
|
480
541
|
| `pathWidth?` | `number` | Width of the path line in pixel. It can be floating point precision (ex: `0.5`) Default: `1` if `hiDPI` is `false` and `2` if `hiDPI` is `true`. |
|
|
481
|
-
| `style?` | `string` | Style of the map (not full style URL). Example: "winter", "streets-v2". Default: `"streets-v2"` |
|
|
542
|
+
| `style?` | `string` \| [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) \| [`MapStyleVariant`](classes/MapStyleVariant.md) | Style of the map (not full style URL). Example: "winter", "streets-v2". Default: `"streets-v2"` |
|
|
482
543
|
| `width?` | `number` | Width of the output image. Maximum value: `2048`. Default: `1024` |
|
|
483
544
|
|
|
484
545
|
#### Defined in
|
|
485
546
|
|
|
486
|
-
[services/staticMaps.ts:
|
|
547
|
+
[services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L10)
|
|
487
548
|
|
|
488
549
|
___
|
|
489
550
|
|
|
@@ -495,7 +556,7 @@ Definition of a maker to show on a static map
|
|
|
495
556
|
|
|
496
557
|
#### Defined in
|
|
497
558
|
|
|
498
|
-
[services/staticMaps.ts:
|
|
559
|
+
[services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L146)
|
|
499
560
|
|
|
500
561
|
___
|
|
501
562
|
|
|
@@ -513,7 +574,7 @@ ___
|
|
|
513
574
|
|
|
514
575
|
#### Defined in
|
|
515
576
|
|
|
516
|
-
[services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/
|
|
577
|
+
[services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L153)
|
|
517
578
|
|
|
518
579
|
## Variables
|
|
519
580
|
|
|
@@ -585,7 +646,23 @@ Languages. Note that not all the languages of this list are available but the co
|
|
|
585
646
|
|
|
586
647
|
#### Defined in
|
|
587
648
|
|
|
588
|
-
[language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/
|
|
649
|
+
[language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/language.ts#L4)
|
|
650
|
+
|
|
651
|
+
___
|
|
652
|
+
|
|
653
|
+
### MapStyle
|
|
654
|
+
|
|
655
|
+
• `Const` **MapStyle**: [`MapStyleType`](README.md#mapstyletype)
|
|
656
|
+
|
|
657
|
+
Contains all the reference map style created by MapTiler team as well as all the variants.
|
|
658
|
+
For example, `MapStyle.STREETS` and the variants:
|
|
659
|
+
- `MapStyle.STREETS.DARK`
|
|
660
|
+
- `MapStyle.STREETS.LIGHT`
|
|
661
|
+
- `MapStyle.STREETS.PASTEL`
|
|
662
|
+
|
|
663
|
+
#### Defined in
|
|
664
|
+
|
|
665
|
+
[mapstyle.ts:841](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/mapstyle.ts#L841)
|
|
589
666
|
|
|
590
667
|
___
|
|
591
668
|
|
|
@@ -597,7 +674,7 @@ Configuration object
|
|
|
597
674
|
|
|
598
675
|
#### Defined in
|
|
599
676
|
|
|
600
|
-
[config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/
|
|
677
|
+
[config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/config.ts#L63)
|
|
601
678
|
|
|
602
679
|
___
|
|
603
680
|
|
|
@@ -617,7 +694,7 @@ The goal of the **Coordinate API* is query information about spatial coordinate
|
|
|
617
694
|
|
|
618
695
|
#### Defined in
|
|
619
696
|
|
|
620
|
-
[services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/
|
|
697
|
+
[services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/coordinates.ts#L253)
|
|
621
698
|
|
|
622
699
|
___
|
|
623
700
|
|
|
@@ -636,7 +713,7 @@ The **Data API** provides a way to retrieve user data in GeoJSON format.
|
|
|
636
713
|
|
|
637
714
|
#### Defined in
|
|
638
715
|
|
|
639
|
-
[services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/
|
|
716
|
+
[services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/data.ts#L59)
|
|
640
717
|
|
|
641
718
|
___
|
|
642
719
|
|
|
@@ -713,7 +790,7 @@ and to get the location details (country, city, street, etc.) from a geographic
|
|
|
713
790
|
|
|
714
791
|
#### Defined in
|
|
715
792
|
|
|
716
|
-
[services/geocoding.ts:233](https://github.com/maptiler/maptiler-client-js/blob/
|
|
793
|
+
[services/geocoding.ts:233](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L233)
|
|
717
794
|
|
|
718
795
|
___
|
|
719
796
|
|
|
@@ -732,7 +809,17 @@ The **Geolocation API** provides a way to retrieve the IP address as well as geo
|
|
|
732
809
|
|
|
733
810
|
#### Defined in
|
|
734
811
|
|
|
735
|
-
[services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/
|
|
812
|
+
[services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geolocation.ts#L135)
|
|
813
|
+
|
|
814
|
+
___
|
|
815
|
+
|
|
816
|
+
### mapStylePresetList
|
|
817
|
+
|
|
818
|
+
• `Const` **mapStylePresetList**: [`MapStylePreset`](README.md#mapstylepreset)[]
|
|
819
|
+
|
|
820
|
+
#### Defined in
|
|
821
|
+
|
|
822
|
+
[mapstyle.ts:433](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/mapstyle.ts#L433)
|
|
736
823
|
|
|
737
824
|
___
|
|
738
825
|
|
|
@@ -753,4 +840,24 @@ The URL of static maps can then be used within a `<img />` markup element, as th
|
|
|
753
840
|
|
|
754
841
|
#### Defined in
|
|
755
842
|
|
|
756
|
-
[services/staticMaps.ts:
|
|
843
|
+
[services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/staticMaps.ts#L457)
|
|
844
|
+
|
|
845
|
+
## Functions
|
|
846
|
+
|
|
847
|
+
### styleToStyle
|
|
848
|
+
|
|
849
|
+
▸ **styleToStyle**(`style`): `string`
|
|
850
|
+
|
|
851
|
+
#### Parameters
|
|
852
|
+
|
|
853
|
+
| Name | Type |
|
|
854
|
+
| :------ | :------ |
|
|
855
|
+
| `style` | `string` \| [`MapStyleVariant`](classes/MapStyleVariant.md) \| [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) |
|
|
856
|
+
|
|
857
|
+
#### Returns
|
|
858
|
+
|
|
859
|
+
`string`
|
|
860
|
+
|
|
861
|
+
#### Defined in
|
|
862
|
+
|
|
863
|
+
[mapstyle.ts:810](https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/mapstyle.ts#L810)
|