Skip to content

Commit 08f62c7

Browse files
committed
deploy docs: v5.12.0 370565b
1 parent 91b1f28 commit 08f62c7

File tree

447 files changed

+17564
-1967
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

447 files changed

+17564
-1967
lines changed

docs/404.html

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6371,6 +6371,29 @@
63716371

63726372

63736373

6374+
<li class="md-nav__item">
6375+
<a href="/maplibre-gl-js/docs/examples/display-a-map-with-mlt/" class="md-nav__link">
6376+
6377+
6378+
6379+
<span class="md-ellipsis">
6380+
Display a map with MLT
6381+
6382+
</span>
6383+
6384+
6385+
</a>
6386+
</li>
6387+
6388+
6389+
6390+
6391+
6392+
6393+
6394+
6395+
6396+
63746397
<li class="md-nav__item">
63756398
<a href="/maplibre-gl-js/docs/examples/display-a-map/" class="md-nav__link">
63766399

docs/API/_media/CONTRIBUTING/index.html

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6699,6 +6699,29 @@
66996699

67006700

67016701

6702+
<li class="md-nav__item">
6703+
<a href="../../../examples/display-a-map-with-mlt/" class="md-nav__link">
6704+
6705+
6706+
6707+
<span class="md-ellipsis">
6708+
Display a map with MLT
6709+
6710+
</span>
6711+
6712+
6713+
</a>
6714+
</li>
6715+
6716+
6717+
6718+
6719+
6720+
6721+
6722+
6723+
6724+
67026725
<li class="md-nav__item">
67036726
<a href="../../../examples/display-a-map/" class="md-nav__link">
67046727

docs/API/classes/AJAXError/index.html

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6561,6 +6561,29 @@
65616561

65626562

65636563

6564+
<li class="md-nav__item">
6565+
<a href="../../../examples/display-a-map-with-mlt/" class="md-nav__link">
6566+
6567+
6568+
6569+
<span class="md-ellipsis">
6570+
Display a map with MLT
6571+
6572+
</span>
6573+
6574+
6575+
</a>
6576+
</li>
6577+
6578+
6579+
6580+
6581+
6582+
6583+
6584+
6585+
6586+
65646587
<li class="md-nav__item">
65656588
<a href="../../../examples/display-a-map/" class="md-nav__link">
65666589

@@ -8283,7 +8306,7 @@
82838306

82848307

82858308
<h1 id="ajaxerror">AJAXError</h1>
8286-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L87">src/util/ajax.ts:87</a></p>
8309+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L87">src/util/ajax.ts:87</a></p>
82878310
<p>An error thrown when a HTTP request results in an error response.</p>
82888311
<h2 id="extends">Extends</h2>
82898312
<ul>
@@ -8294,7 +8317,7 @@ <h3 id="constructor">Constructor</h3>
82948317
<blockquote>
82958318
<p><strong>new AJAXError</strong>(<code>status</code>: <code>number</code>, <code>statusText</code>: <code>string</code>, <code>url</code>: <code>string</code>, <code>body</code>: <code>Blob</code>): <code>AJAXError</code></p>
82968319
</blockquote>
8297-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L114">src/util/ajax.ts:114</a></p>
8320+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L114">src/util/ajax.ts:114</a></p>
82988321
<h4 id="parameters">Parameters</h4>
82998322
<table>
83008323
<thead>
@@ -8336,28 +8359,28 @@ <h3 id="body">body</h3>
83368359
<blockquote>
83378360
<p><strong>body</strong>: <code>Blob</code></p>
83388361
</blockquote>
8339-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L106">src/util/ajax.ts:106</a></p>
8362+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L106">src/util/ajax.ts:106</a></p>
83408363
<p>The response's body.</p>
83418364
<hr />
83428365
<h3 id="status">status</h3>
83438366
<blockquote>
83448367
<p><strong>status</strong>: <code>number</code></p>
83458368
</blockquote>
8346-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L91">src/util/ajax.ts:91</a></p>
8369+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L91">src/util/ajax.ts:91</a></p>
83478370
<p>The response's HTTP status code.</p>
83488371
<hr />
83498372
<h3 id="statustext">statusText</h3>
83508373
<blockquote>
83518374
<p><strong>statusText</strong>: <code>string</code></p>
83528375
</blockquote>
8353-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L96">src/util/ajax.ts:96</a></p>
8376+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L96">src/util/ajax.ts:96</a></p>
83548377
<p>The response's HTTP status text.</p>
83558378
<hr />
83568379
<h3 id="url">url</h3>
83578380
<blockquote>
83588381
<p><strong>url</strong>: <code>string</code></p>
83598382
</blockquote>
8360-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/util/ajax.ts#L101">src/util/ajax.ts:101</a></p>
8383+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/util/ajax.ts#L101">src/util/ajax.ts:101</a></p>
83618384
<p>The request's URL.</p>
83628385

83638386

docs/API/classes/AttributionControl/index.html

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6561,6 +6561,29 @@
65616561

65626562

65636563

6564+
<li class="md-nav__item">
6565+
<a href="../../../examples/display-a-map-with-mlt/" class="md-nav__link">
6566+
6567+
6568+
6569+
<span class="md-ellipsis">
6570+
Display a map with MLT
6571+
6572+
</span>
6573+
6574+
6575+
</a>
6576+
</li>
6577+
6578+
6579+
6580+
6581+
6582+
6583+
6584+
6585+
6586+
65646587
<li class="md-nav__item">
65656588
<a href="../../../examples/display-a-map/" class="md-nav__link">
65666589

@@ -8283,7 +8306,7 @@
82838306

82848307

82858308
<h1 id="attributioncontrol">AttributionControl</h1>
8286-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/control/attribution_control.ts#L39">src/ui/control/attribution_control.ts:39</a></p>
8309+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/control/attribution_control.ts#L39">src/ui/control/attribution_control.ts:39</a></p>
82878310
<p>An <code>AttributionControl</code> control presents the map's attribution information. By default, the attribution control is expanded (regardless of map width).</p>
82888311
<h2 id="example">Example</h2>
82898312
<div class="language-ts 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="kd">let</span><span class="w"> </span><span class="nx">map</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nb">Map</span><span class="p">({</span><span class="nx">attributionControl</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">})</span>
@@ -8300,7 +8323,7 @@ <h3 id="constructor">Constructor</h3>
83008323
<blockquote>
83018324
<p><strong>new AttributionControl</strong>(<code>options</code>: <a href="../../type-aliases/AttributionControlOptions/"><code>AttributionControlOptions</code></a>): <code>AttributionControl</code></p>
83028325
</blockquote>
8303-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/control/attribution_control.ts#L54">src/ui/control/attribution_control.ts:54</a></p>
8326+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/control/attribution_control.ts#L54">src/ui/control/attribution_control.ts:54</a></p>
83048327
<h4 id="parameters">Parameters</h4>
83058328
<table>
83068329
<thead>
@@ -8327,7 +8350,7 @@ <h3 id="getdefaultposition">getDefaultPosition()</h3>
83278350
<blockquote>
83288351
<p><strong>getDefaultPosition</strong>(): <a href="../../type-aliases/ControlPosition/"><code>ControlPosition</code></a></p>
83298352
</blockquote>
8330-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
8353+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
83318354
<p>Optionally provide a default position for this control. If this method
83328355
is implemented and <a href="../Map/#addcontrol">Map.addControl</a> is called without the <code>position</code>
83338356
parameter, the value returned by getDefaultPosition will be used as the
@@ -8342,7 +8365,7 @@ <h3 id="onadd">onAdd()</h3>
83428365
<blockquote>
83438366
<p><strong>onAdd</strong>(<code>map</code>: <a href="../Map/"><code>Map</code></a>): <code>HTMLElement</code></p>
83448367
</blockquote>
8345-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/control/attribution_control.ts#L63">src/ui/control/attribution_control.ts:63</a></p>
8368+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/control/attribution_control.ts#L63">src/ui/control/attribution_control.ts:63</a></p>
83468369
<p>Register a control on the map and give it a chance to register event listeners
83478370
and resources. This method is called by <a href="../Map/#addcontrol">Map.addControl</a>
83488371
internally.</p>
@@ -8376,7 +8399,7 @@ <h3 id="onremove">onRemove()</h3>
83768399
<blockquote>
83778400
<p><strong>onRemove</strong>(): <code>void</code></p>
83788401
</blockquote>
8379-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/control/attribution_control.ts#L85">src/ui/control/attribution_control.ts:85</a></p>
8402+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/control/attribution_control.ts#L85">src/ui/control/attribution_control.ts:85</a></p>
83808403
<p>Unregister a control on the map and give it a chance to detach event listeners
83818404
and resources. This method is called by <a href="../Map/#removecontrol">Map.removeControl</a>
83828405
internally.</p>

docs/API/classes/BoxZoomHandler/index.html

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6546,6 +6546,29 @@
65466546

65476547

65486548

6549+
<li class="md-nav__item">
6550+
<a href="../../../examples/display-a-map-with-mlt/" class="md-nav__link">
6551+
6552+
6553+
6554+
<span class="md-ellipsis">
6555+
Display a map with MLT
6556+
6557+
</span>
6558+
6559+
6560+
</a>
6561+
</li>
6562+
6563+
6564+
6565+
6566+
6567+
6568+
6569+
6570+
6571+
65496572
<li class="md-nav__item">
65506573
<a href="../../../examples/display-a-map/" class="md-nav__link">
65516574

@@ -8253,7 +8276,7 @@
82538276

82548277

82558278
<h1 id="boxzoomhandler">BoxZoomHandler</h1>
8256-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L16">src/ui/handler/box_zoom.ts:16</a></p>
8279+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L16">src/ui/handler/box_zoom.ts:16</a></p>
82578280
<p>The <code>BoxZoomHandler</code> allows the user to zoom the map to fit within a bounding box.
82588281
The bounding box is defined by clicking and holding <code>shift</code> while dragging the cursor.</p>
82598282
<h2 id="implements">Implements</h2>
@@ -8265,7 +8288,7 @@ <h3 id="disable">disable()</h3>
82658288
<blockquote>
82668289
<p><strong>disable</strong>(): <code>void</code></p>
82678290
</blockquote>
8268-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L78">src/ui/handler/box_zoom.ts:78</a></p>
8291+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L78">src/ui/handler/box_zoom.ts:78</a></p>
82698292
<p>Disables the "box zoom" interaction.</p>
82708293
<h4 id="returns">Returns</h4>
82718294
<p><code>void</code></p>
@@ -8279,7 +8302,7 @@ <h3 id="enable">enable()</h3>
82798302
<blockquote>
82808303
<p><strong>enable</strong>(): <code>void</code></p>
82818304
</blockquote>
8282-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L65">src/ui/handler/box_zoom.ts:65</a></p>
8305+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L65">src/ui/handler/box_zoom.ts:65</a></p>
82838306
<p>Enables the "box zoom" interaction.</p>
82848307
<h4 id="returns_1">Returns</h4>
82858308
<p><code>void</code></p>
@@ -8293,7 +8316,7 @@ <h3 id="isactive">isActive()</h3>
82938316
<blockquote>
82948317
<p><strong>isActive</strong>(): <code>boolean</code></p>
82958318
</blockquote>
8296-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L53">src/ui/handler/box_zoom.ts:53</a></p>
8319+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L53">src/ui/handler/box_zoom.ts:53</a></p>
82978320
<p>Returns a Boolean indicating whether the "box zoom" interaction is active, i.e. currently being used.</p>
82988321
<h4 id="returns_2">Returns</h4>
82998322
<p><code>boolean</code></p>
@@ -8305,7 +8328,7 @@ <h3 id="isenabled">isEnabled()</h3>
83058328
<blockquote>
83068329
<p><strong>isEnabled</strong>(): <code>boolean</code></p>
83078330
</blockquote>
8308-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L44">src/ui/handler/box_zoom.ts:44</a></p>
8331+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L44">src/ui/handler/box_zoom.ts:44</a></p>
83098332
<p>Returns a Boolean indicating whether the "box zoom" interaction is enabled.</p>
83108333
<h4 id="returns_3">Returns</h4>
83118334
<p><code>boolean</code></p>
@@ -8317,7 +8340,7 @@ <h3 id="reset">reset()</h3>
83178340
<blockquote>
83188341
<p><strong>reset</strong>(): <code>void</code></p>
83198342
</blockquote>
8320-
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/25d189b0b13391614d3a6e7d4308095a5c960423/src/ui/handler/box_zoom.ts#L152">src/ui/handler/box_zoom.ts:152</a></p>
8343+
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/370565ba1eef0f270347585f9d8f964e002de73f/src/ui/handler/box_zoom.ts#L152">src/ui/handler/box_zoom.ts:152</a></p>
83218344
<p><code>reset</code> can be called by the manager at any time and must reset everything to it's original state</p>
83228345
<h4 id="returns_4">Returns</h4>
83238346
<p><code>void</code></p>

0 commit comments

Comments
 (0)