Skip to content

Commit

Permalink
deploy docs: v3.5.2 ff348da
Browse files Browse the repository at this point in the history
  • Loading branch information
HarelM committed Oct 25, 2023
1 parent 2b1235d commit e00772a
Show file tree
Hide file tree
Showing 349 changed files with 12,660 additions and 1,454 deletions.
22 changes: 21 additions & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -1821,6 +1821,26 @@








<li class="md-nav__item">
<a href="/maplibre-gl-js/docs/API/interfaces/maplibregl.WorkerSource/" class="md-nav__link">


<span class="md-ellipsis">
Interface: WorkerSource
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -5553,7 +5573,7 @@


<span class="md-ellipsis">
Variable label placement
Variable label placement with offset
</span>


Expand Down
40 changes: 30 additions & 10 deletions docs/API/classes/default/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1980,6 +1980,26 @@








<li class="md-nav__item">
<a href="../../interfaces/maplibregl.WorkerSource/" class="md-nav__link">


<span class="md-ellipsis">
Interface: WorkerSource
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -5712,7 +5732,7 @@


<span class="md-ellipsis">
Variable label placement
Variable label placement with offset
</span>


Expand Down Expand Up @@ -5989,7 +6009,7 @@ <h4 id="returns">Returns</h4>
<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="nx">maplibregl</span><span class="p">.</span><span class="nx">maxParallelImageRequests</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">10</span><span class="p">;</span>
</span></code></pre></div>
<h4 id="defined-in">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L168">src/index.ts:168</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L168">src/index.ts:168</a></p>
<hr />
<h3 id="version">version</h3>
<p><code>Static</code> <code>get</code> <strong>version</strong>(): <code>string</code></p>
Expand All @@ -5998,7 +6018,7 @@ <h4 id="returns_1">Returns</h4>
<p><code>string</code></p>
<p>Package version of the library</p>
<h4 id="defined-in_1">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L136">src/index.ts:136</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L136">src/index.ts:136</a></p>
<hr />
<h3 id="workercount">workerCount</h3>
<p><code>Static</code> <code>get</code> <strong>workerCount</strong>(): <code>number</code></p>
Expand All @@ -6012,7 +6032,7 @@ <h4 id="returns_2">Returns</h4>
<div class="language-ts highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nx">maplibregl</span><span class="p">.</span><span class="nx">workerCount</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">2</span><span class="p">;</span>
</span></code></pre></div>
<h4 id="defined-in_2">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L151">src/index.ts:151</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L151">src/index.ts:151</a></p>
<h2 id="methods">Methods</h2>
<h3 id="addprotocol">addProtocol</h3>
<p><code>Static</code> <strong>addProtocol</strong>(<code>customProtocol</code>, <code>loadFn</code>): <code>void</code></p>
Expand Down Expand Up @@ -6069,7 +6089,7 @@ <h4 id="returns_3">Returns</h4>
</span><span id="__span-2-21"><a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a><span class="p">});</span>
</span></code></pre></div></p>
<h4 id="defined-in_3">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L218">src/index.ts:218</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L218">src/index.ts:218</a></p>
<hr />
<h3 id="removeprotocol">removeProtocol</h3>
<p><code>Static</code> <strong>removeProtocol</strong>(<code>customProtocol</code>): <code>void</code></p>
Expand Down Expand Up @@ -6097,7 +6117,7 @@ <h4 id="returns_4">Returns</h4>
<div class="language-ts highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nx">maplibregl</span><span class="p">.</span><span class="nx">removeProtocol</span><span class="p">(</span><span class="s1">&#39;custom&#39;</span><span class="p">);</span>
</span></code></pre></div>
<h4 id="defined-in_4">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L231">src/index.ts:231</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L231">src/index.ts:231</a></p>
<h2 id="properties">Properties</h2>
<h3 id="clearprewarmedresources">clearPrewarmedResources</h3>
<p><code>Static</code> <strong>clearPrewarmedResources</strong>: () =&gt; <code>void</code> = <code>clearPrewarmedResources</code></p>
Expand All @@ -6113,7 +6133,7 @@ <h5 id="returns_5">Returns</h5>
<div class="language-ts highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nx">maplibregl</span><span class="p">.</span><span class="nx">clearPrewarmedResources</span><span class="p">()</span>
</span></code></pre></div>
<h4 id="defined-in_5">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L131">src/index.ts:131</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L131">src/index.ts:131</a></p>
<hr />
<h3 id="getrtltextpluginstatus">getRTLTextPluginStatus</h3>
<p><code>Static</code> <strong>getRTLTextPluginStatus</strong>: () =&gt; <code>string</code> = <code>getRTLTextPluginStatus</code></p>
Expand All @@ -6128,7 +6148,7 @@ <h5 id="returns_6">Returns</h5>
<div class="language-ts highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="kd">const</span><span class="w"> </span><span class="nx">pluginStatus</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">maplibregl</span><span class="p">.</span><span class="nx">getRTLTextPluginStatus</span><span class="p">();</span>
</span></code></pre></div>
<h4 id="defined-in_6">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L96">src/index.ts:96</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L96">src/index.ts:96</a></p>
<hr />
<h3 id="prewarm">prewarm</h3>
<p><code>Static</code> <strong>prewarm</strong>: () =&gt; <code>void</code> = <code>prewarm</code></p>
Expand All @@ -6153,7 +6173,7 @@ <h5 id="returns_7">Returns</h5>
<div class="language-ts highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="nx">maplibregl</span><span class="p">.</span><span class="nx">prewarm</span><span class="p">()</span>
</span></code></pre></div>
<h4 id="defined-in_7">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L119">src/index.ts:119</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L119">src/index.ts:119</a></p>
<hr />
<h3 id="setrtltextplugin">setRTLTextPlugin</h3>
<p><code>Static</code> <strong>setRTLTextPlugin</strong>: (<code>url</code>: <code>string</code>, <code>callback</code>: <a href="../../types/maplibregl.ErrorCallback/"><code>ErrorCallback</code></a>, <code>deferred</code>: <code>boolean</code>) =&gt; <code>void</code> = <code>setRTLTextPlugin</code></p>
Expand Down Expand Up @@ -6200,7 +6220,7 @@ <h5 id="returns_8">Returns</h5>
<p><strong><code>See</code></strong></p>
<p><a href="https://maplibre.org/maplibre-gl-js/docs/examples/mapbox-gl-rtl-text/">Add support for right-to-left scripts</a></p>
<h4 id="defined-in_8">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/index.ts#L85">src/index.ts:85</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/index.ts#L85">src/index.ts:85</a></p>



Expand Down
32 changes: 26 additions & 6 deletions docs/API/classes/maplibregl.AJAXError/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1946,6 +1946,26 @@








<li class="md-nav__item">
<a href="../../interfaces/maplibregl.WorkerSource/" class="md-nav__link">


<span class="md-ellipsis">
Interface: WorkerSource
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -5678,7 +5698,7 @@


<span class="md-ellipsis">
Variable label placement
Variable label placement with offset
</span>


Expand Down Expand Up @@ -5953,31 +5973,31 @@ <h4 id="parameters">Parameters</h4>
<h4 id="overrides">Overrides</h4>
<p>Error.constructor</p>
<h4 id="defined-in">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/ajax.ts#L98">src/util/ajax.ts:98</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/ajax.ts#L98">src/util/ajax.ts:98</a></p>
<h2 id="properties">Properties</h2>
<h3 id="body">body</h3>
<p><strong>body</strong>: <code>Blob</code></p>
<p>The response's body.</p>
<h4 id="defined-in_1">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/ajax.ts#L90">src/util/ajax.ts:90</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/ajax.ts#L90">src/util/ajax.ts:90</a></p>
<hr />
<h3 id="status">status</h3>
<p><strong>status</strong>: <code>number</code></p>
<p>The response's HTTP status code.</p>
<h4 id="defined-in_2">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/ajax.ts#L75">src/util/ajax.ts:75</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/ajax.ts#L75">src/util/ajax.ts:75</a></p>
<hr />
<h3 id="statustext">statusText</h3>
<p><strong>statusText</strong>: <code>string</code></p>
<p>The response's HTTP status text.</p>
<h4 id="defined-in_3">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/ajax.ts#L80">src/util/ajax.ts:80</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/ajax.ts#L80">src/util/ajax.ts:80</a></p>
<hr />
<h3 id="url">url</h3>
<p><strong>url</strong>: <code>string</code></p>
<p>The request's URL.</p>
<h4 id="defined-in_4">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/ajax.ts#L85">src/util/ajax.ts:85</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/ajax.ts#L85">src/util/ajax.ts:85</a></p>



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








<li class="md-nav__item">
<a href="../../interfaces/maplibregl.WorkerSource/" class="md-nav__link">


<span class="md-ellipsis">
Interface: WorkerSource
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -5650,7 +5670,7 @@


<span class="md-ellipsis">
Variable label placement
Variable label placement with offset
</span>


Expand Down Expand Up @@ -5872,23 +5892,23 @@ <h4 id="parameters">Parameters</h4>
<tbody>
<tr>
<td style="text-align: left;"><code>target</code></td>
<td style="text-align: left;"><code>any</code></td>
<td style="text-align: left;"><code>ActorTarget</code></td>
<td style="text-align: left;">The target</td>
</tr>
<tr>
<td style="text-align: left;"><code>parent</code></td>
<td style="text-align: left;"><code>any</code></td>
<td style="text-align: left;"><code>WorkerSourceProvider</code> | <code>GlyphsProvider</code></td>
<td style="text-align: left;">The parent</td>
</tr>
<tr>
<td style="text-align: left;"><code>mapId?</code></td>
<td style="text-align: left;"><code>string</code></td>
<td style="text-align: left;"><code>string</code> | <code>number</code></td>
<td style="text-align: left;">A unique identifier for the Map instance using this Actor.</td>
</tr>
</tbody>
</table>
<h4 id="defined-in">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/actor.ts#L37">src/util/actor.ts:37</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/actor.ts#L79">src/util/actor.ts:79</a></p>
<h2 id="methods">Methods</h2>
<h3 id="send">send</h3>
<p><strong>send</strong>(<code>type</code>, <code>data</code>, <code>callback?</code>, <code>targetMapId?</code>, <code>mustQueue?</code>): <a href="../../types/maplibregl.Cancelable/"><code>Cancelable</code></a></p>
Expand All @@ -5907,7 +5927,7 @@ <h4 id="parameters_1">Parameters</h4>
<tbody>
<tr>
<td style="text-align: left;"><code>type</code></td>
<td style="text-align: left;"><code>string</code></td>
<td style="text-align: left;"><code>MessageType</code></td>
<td style="text-align: left;"><code>undefined</code></td>
<td style="text-align: left;">The name of the target method to invoke or '[source-type].[source-name].name' for a method on a WorkerSource.</td>
</tr>
Expand Down Expand Up @@ -5940,7 +5960,7 @@ <h4 id="parameters_1">Parameters</h4>
<h4 id="returns">Returns</h4>
<p><a href="../../types/maplibregl.Cancelable/"><code>Cancelable</code></a></p>
<h4 id="defined-in_1">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/util/actor.ts#L57">src/util/actor.ts:57</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/util/actor.ts#L99">src/util/actor.ts:99</a></p>



Expand Down
28 changes: 24 additions & 4 deletions docs/API/classes/maplibregl.AttributionControl/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1932,6 +1932,26 @@








<li class="md-nav__item">
<a href="../../interfaces/maplibregl.WorkerSource/" class="md-nav__link">


<span class="md-ellipsis">
Interface: WorkerSource
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -5664,7 +5684,7 @@


<span class="md-ellipsis">
Variable label placement
Variable label placement with offset
</span>


Expand Down Expand Up @@ -5913,7 +5933,7 @@ <h4 id="parameters">Parameters</h4>
</tbody>
</table>
<h4 id="defined-in">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/ui/control/attribution_control.ts#L49">src/ui/control/attribution_control.ts:49</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/ui/control/attribution_control.ts#L49">src/ui/control/attribution_control.ts:49</a></p>
<h2 id="methods">Methods</h2>
<h3 id="onadd">onAdd</h3>
<p><strong>onAdd</strong>(<code>map</code>): <code>HTMLElement</code></p>
Expand Down Expand Up @@ -5946,7 +5966,7 @@ <h4 id="returns">Returns</h4>
<h4 id="implementation-of">Implementation of</h4>
<p><a href="../../interfaces/maplibregl.IControl/">IControl</a>.<a href="../../interfaces/maplibregl.IControl/#onadd">onAdd</a></p>
<h4 id="defined-in_1">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/ui/control/attribution_control.ts#L58">src/ui/control/attribution_control.ts:58</a></p>
<hr />
<h3 id="onremove">onRemove</h3>
<p><strong>onRemove</strong>(): <code>void</code></p>
Expand All @@ -5958,7 +5978,7 @@ <h4 id="returns_1">Returns</h4>
<h4 id="implementation-of_1">Implementation of</h4>
<p><a href="../../interfaces/maplibregl.IControl/">IControl</a>.<a href="../../interfaces/maplibregl.IControl/#onremove">onRemove</a></p>
<h4 id="defined-in_2">Defined in</h4>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/f3f95f22e/src/ui/control/attribution_control.ts#L80">src/ui/control/attribution_control.ts:80</a></p>
<p><a href="https://github.com/maplibre/maplibre-gl-js/blob/ff348dacb/src/ui/control/attribution_control.ts#L80">src/ui/control/attribution_control.ts:80</a></p>



Expand Down
Loading

0 comments on commit e00772a

Please sign in to comment.