Skip to content

Commit

Permalink
deploy docs: v5.0.1 f1d58f2
Browse files Browse the repository at this point in the history
  • Loading branch information
HarelM committed Jan 12, 2025
1 parent 81350b1 commit 720e593
Show file tree
Hide file tree
Showing 811 changed files with 1,713 additions and 1,709 deletions.
12 changes: 6 additions & 6 deletions docs/API/classes/AJAXError/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8458,7 +8458,7 @@


<h1 id="ajaxerror">AJAXError</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L87">src/util/ajax.ts:87</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L87">src/util/ajax.ts:87</a></p>
<p>An error thrown when a HTTP request results in an error response.</p>
<h2 id="extends">Extends</h2>
<ul>
Expand All @@ -8469,7 +8469,7 @@ <h3 id="new-ajaxerror">new AJAXError()</h3>
<blockquote>
<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>): <a href="./"><code>AJAXError</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L114">src/util/ajax.ts:114</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L114">src/util/ajax.ts:114</a></p>
<h4 id="parameters">Parameters</h4>
<table>
<thead>
Expand Down Expand Up @@ -8511,28 +8511,28 @@ <h3 id="body">body</h3>
<blockquote>
<p><strong>body</strong>: <code>Blob</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L106">src/util/ajax.ts:106</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L106">src/util/ajax.ts:106</a></p>
<p>The response's body.</p>
<hr />
<h3 id="status">status</h3>
<blockquote>
<p><strong>status</strong>: <code>number</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L91">src/util/ajax.ts:91</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L91">src/util/ajax.ts:91</a></p>
<p>The response's HTTP status code.</p>
<hr />
<h3 id="statustext">statusText</h3>
<blockquote>
<p><strong>statusText</strong>: <code>string</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L96">src/util/ajax.ts:96</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L96">src/util/ajax.ts:96</a></p>
<p>The response's HTTP status text.</p>
<hr />
<h3 id="url">url</h3>
<blockquote>
<p><strong>url</strong>: <code>string</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/ajax.ts#L101">src/util/ajax.ts:101</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/ajax.ts#L101">src/util/ajax.ts:101</a></p>
<p>The request's URL.</p>


Expand Down
6 changes: 3 additions & 3 deletions docs/API/classes/Actor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8404,7 +8404,7 @@


<h1 id="actor">Actor</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/actor.ts#L54">src/util/actor.ts:54</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/actor.ts#L54">src/util/actor.ts:54</a></p>
<p>An implementation of the <a href="https://en.wikipedia.org/wiki/Actor_model">Actor design pattern</a>
that maintains the relationship between asynchronous tasks and the objects
that spin them off - in this case, tasks like parsing parts of styles,
Expand All @@ -8418,7 +8418,7 @@ <h3 id="new-actor">new Actor()</h3>
<blockquote>
<p><strong>new Actor</strong>(<code>target</code>: <a href="../../interfaces/ActorTarget/"><code>ActorTarget</code></a>, <code>mapId</code>?: <code>string</code> | <code>number</code>): <a href="./"><code>Actor</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/actor.ts#L71">src/util/actor.ts:71</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/actor.ts#L71">src/util/actor.ts:71</a></p>
<h4 id="parameters">Parameters</h4>
<table>
<thead>
Expand Down Expand Up @@ -8448,7 +8448,7 @@ <h3 id="sendasync">sendAsync()</h3>
<blockquote>
<p><strong>sendAsync</strong>&lt;<code>T</code>&gt;(<code>message</code>: <a href="../../type-aliases/ActorMessage/"><code>ActorMessage</code></a>&lt;<code>T</code>&gt;, <code>abortController</code>?: <code>AbortController</code>): <code>Promise</code>&lt;<a href="../../type-aliases/RequestResponseMessageMap/"><code>RequestResponseMessageMap</code></a>[<code>T</code>][<code>1</code>]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/actor.ts#L95">src/util/actor.ts:95</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/actor.ts#L95">src/util/actor.ts:95</a></p>
<p>Sends a message from a main-thread map to a Worker or from a Worker back to
a main-thread map instance.</p>
<h4 id="type-parameters">Type Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/API/classes/AlphaImage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8252,7 +8252,7 @@


<h1 id="alphaimage">AlphaImage</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/util/image.ts#L87">src/util/image.ts:87</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/util/image.ts#L87">src/util/image.ts:87</a></p>
<p>An image with alpha color value</p>


Expand Down
10 changes: 5 additions & 5 deletions docs/API/classes/AttributionControl/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8458,7 +8458,7 @@


<h1 id="attributioncontrol">AttributionControl</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/control/attribution_control.ts#L39">src/ui/control/attribution_control.ts:39</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/control/attribution_control.ts#L39">src/ui/control/attribution_control.ts:39</a></p>
<p>An <code>AttributionControl</code> control presents the map's attribution information. By default, the attribution control is expanded (regardless of map width).</p>
<h2 id="example">Example</h2>
<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>
Expand All @@ -8475,7 +8475,7 @@ <h3 id="new-attributioncontrol">new AttributionControl()</h3>
<blockquote>
<p><strong>new AttributionControl</strong>(<code>options</code>: <a href="../../type-aliases/AttributionControlOptions/"><code>AttributionControlOptions</code></a>): <a href="./"><code>AttributionControl</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/control/attribution_control.ts#L54">src/ui/control/attribution_control.ts:54</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/control/attribution_control.ts#L54">src/ui/control/attribution_control.ts:54</a></p>
<h4 id="parameters">Parameters</h4>
<table>
<thead>
Expand All @@ -8502,7 +8502,7 @@ <h3 id="getdefaultposition">getDefaultPosition()</h3>
<blockquote>
<p><strong>getDefaultPosition</strong>(): <a href="../../type-aliases/ControlPosition/"><code>ControlPosition</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
<p>Optionally provide a default position for this control. If this method
is implemented and <a href="../Map/#addcontrol">Map#addControl</a> is called without the <code>position</code>
parameter, the value returned by getDefaultPosition will be used as the
Expand All @@ -8517,7 +8517,7 @@ <h3 id="onadd">onAdd()</h3>
<blockquote>
<p><strong>onAdd</strong>(<code>map</code>: <a href="../Map/"><code>Map</code></a>): <code>HTMLElement</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/control/attribution_control.ts#L63">src/ui/control/attribution_control.ts:63</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/control/attribution_control.ts#L63">src/ui/control/attribution_control.ts:63</a></p>
<p>Register a control on the map and give it a chance to register event listeners
and resources. This method is called by <a href="../Map/#addcontrol">Map#addControl</a>
internally.</p>
Expand Down Expand Up @@ -8551,7 +8551,7 @@ <h3 id="onremove">onRemove()</h3>
<blockquote>
<p><strong>onRemove</strong>(): <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/control/attribution_control.ts#L85">src/ui/control/attribution_control.ts:85</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/control/attribution_control.ts#L85">src/ui/control/attribution_control.ts:85</a></p>
<p>Unregister a control on the map and give it a chance to detach event listeners
and resources. This method is called by <a href="../Map/#removecontrol">Map#removeControl</a>
internally.</p>
Expand Down
12 changes: 6 additions & 6 deletions docs/API/classes/BoxZoomHandler/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8428,7 +8428,7 @@


<h1 id="boxzoomhandler">BoxZoomHandler</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L16">src/ui/handler/box_zoom.ts:16</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L16">src/ui/handler/box_zoom.ts:16</a></p>
<p>The <code>BoxZoomHandler</code> allows the user to zoom the map to fit within a bounding box.
The bounding box is defined by clicking and holding <code>shift</code> while dragging the cursor.</p>
<h2 id="implements">Implements</h2>
Expand All @@ -8440,7 +8440,7 @@ <h3 id="disable">disable()</h3>
<blockquote>
<p><strong>disable</strong>(): <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L78">src/ui/handler/box_zoom.ts:78</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L78">src/ui/handler/box_zoom.ts:78</a></p>
<p>Disables the "box zoom" interaction.</p>
<h4 id="returns">Returns</h4>
<p><code>void</code></p>
Expand All @@ -8454,7 +8454,7 @@ <h3 id="enable">enable()</h3>
<blockquote>
<p><strong>enable</strong>(): <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L65">src/ui/handler/box_zoom.ts:65</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L65">src/ui/handler/box_zoom.ts:65</a></p>
<p>Enables the "box zoom" interaction.</p>
<h4 id="returns_1">Returns</h4>
<p><code>void</code></p>
Expand All @@ -8468,7 +8468,7 @@ <h3 id="isactive">isActive()</h3>
<blockquote>
<p><strong>isActive</strong>(): <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L53">src/ui/handler/box_zoom.ts:53</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L53">src/ui/handler/box_zoom.ts:53</a></p>
<p>Returns a Boolean indicating whether the "box zoom" interaction is active, i.e. currently being used.</p>
<h4 id="returns_2">Returns</h4>
<p><code>boolean</code></p>
Expand All @@ -8480,7 +8480,7 @@ <h3 id="isenabled">isEnabled()</h3>
<blockquote>
<p><strong>isEnabled</strong>(): <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L44">src/ui/handler/box_zoom.ts:44</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L44">src/ui/handler/box_zoom.ts:44</a></p>
<p>Returns a Boolean indicating whether the "box zoom" interaction is enabled.</p>
<h4 id="returns_3">Returns</h4>
<p><code>boolean</code></p>
Expand All @@ -8492,7 +8492,7 @@ <h3 id="reset">reset()</h3>
<blockquote>
<p><strong>reset</strong>(): <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/ui/handler/box_zoom.ts#L152">src/ui/handler/box_zoom.ts:152</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/ui/handler/box_zoom.ts#L152">src/ui/handler/box_zoom.ts:152</a></p>
<p><code>reset</code> can be called by the manager at any time and must reset everything to it's original state</p>
<h4 id="returns_4">Returns</h4>
<p><code>void</code></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/API/classes/CanonicalTileID/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8308,7 +8308,7 @@


<h1 id="canonicaltileid">CanonicalTileID</h1>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/47ed30d6ec105cbfb8768fd27da1b317af31b903/src/source/tile_id.ts#L14">src/source/tile_id.ts:14</a></p>
<p>Defined in: <a href="https://github.com/maplibre/maplibre-gl-js/blob/f1d58f29d9c27aa2c7268375736cb5f983388262/src/source/tile_id.ts#L14">src/source/tile_id.ts:14</a></p>
<p>A canonical way to define a tile ID</p>
<h2 id="implements">Implements</h2>
<ul>
Expand Down
Loading

0 comments on commit 720e593

Please sign in to comment.