Skip to content

Commit

Permalink
Deployed e18d100 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Kuethe committed Jun 28, 2024
1 parent 30438af commit a38cd8c
Show file tree
Hide file tree
Showing 34 changed files with 2,355 additions and 188 deletions.
21 changes: 21 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -954,6 +954,27 @@









<li class="md-nav__item">
<a href="/examples/layer_switcher/" class="md-nav__link">


<span class="md-ellipsis">
Layer Switcher
</span>


</a>
</li>




</ul>
</nav>

Expand Down
21 changes: 21 additions & 0 deletions api/basemaps/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1024,6 +1024,27 @@









<li class="md-nav__item">
<a href="../../examples/layer_switcher/" class="md-nav__link">


<span class="md-ellipsis">
Layer Switcher
</span>


</a>
</li>




</ul>
</nav>

Expand Down
280 changes: 275 additions & 5 deletions api/controls/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,24 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#maplibre.controls.InfoBoxControl" class="md-nav__link">
<span class="md-ellipsis">
InfoBoxControl
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#maplibre.controls.LayerSwitcherControl" class="md-nav__link">
<span class="md-ellipsis">
LayerSwitcherControl
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -1087,6 +1105,27 @@









<li class="md-nav__item">
<a href="../../examples/layer_switcher/" class="md-nav__link">


<span class="md-ellipsis">
Layer Switcher
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -1197,6 +1236,24 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#maplibre.controls.InfoBoxControl" class="md-nav__link">
<span class="md-ellipsis">
InfoBoxControl
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#maplibre.controls.LayerSwitcherControl" class="md-nav__link">
<span class="md-ellipsis">
LayerSwitcherControl
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -1752,13 +1809,11 @@ <h2 id="maplibre.controls.ScaleControl" class="doc doc-heading">
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
<span class="normal"><a href="#__codelineno-0-150">150</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-145"><a id="__codelineno-0-145" name="__codelineno-0-145"></a><span class="k">class</span> <span class="nc">ScaleControl</span><span class="p">(</span><span class="n">Control</span><span class="p">):</span>
<span class="normal"><a href="#__codelineno-0-149">149</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-145"><a id="__codelineno-0-145" name="__codelineno-0-145"></a><span class="k">class</span> <span class="nc">ScaleControl</span><span class="p">(</span><span class="n">Control</span><span class="p">):</span>
</span><span id="__span-0-146"><a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Scale control&quot;&quot;&quot;</span>
</span><span id="__span-0-147"><a id="__codelineno-0-147" name="__codelineno-0-147"></a>
</span><span id="__span-0-148"><a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="c1"># _name: str = ControlType.SCALE.value</span>
</span><span id="__span-0-149"><a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">max_width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">serialization_alias</span><span class="o">=</span><span class="s2">&quot;maxWidth&quot;</span><span class="p">)</span>
</span><span id="__span-0-150"><a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="n">unit</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;imperial&quot;</span><span class="p">,</span> <span class="s2">&quot;metric&quot;</span><span class="p">,</span> <span class="s2">&quot;nautical&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;metric&quot;</span>
</span><span id="__span-0-148"><a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="n">max_width</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">serialization_alias</span><span class="o">=</span><span class="s2">&quot;maxWidth&quot;</span><span class="p">)</span>
</span><span id="__span-0-149"><a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">unit</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;imperial&quot;</span><span class="p">,</span> <span class="s2">&quot;metric&quot;</span><span class="p">,</span> <span class="s2">&quot;nautical&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;metric&quot;</span>
</span></code></pre></div></td></tr></table></div>
</details>

Expand Down Expand Up @@ -1894,6 +1949,221 @@ <h2 id="maplibre.controls.GeolocateControl" class="doc doc-heading">



</div>

</div>


</div>

<div class="doc doc-object doc-class">



<h2 id="maplibre.controls.InfoBoxControl" class="doc doc-heading">
<code>maplibre.controls.InfoBoxControl</code>


</h2>


<div class="doc doc-contents first">
<p class="doc doc-class-bases">
Bases: <code><span title="maplibre.controls.Control">Control</span></code></p>


<p>InfoBox control</p>



<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="maplibre.controls.InfoBoxControl.content">content</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Content (HTML or plain text) to be displayed in the info box.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="maplibre.controls.InfoBoxControl.css_text">css_text</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional inline style declaration of the control.</p>
</div>
</td>
</tr>
</tbody>
</table>

<details class="quote">
<summary>Source code in <code>maplibre/controls.py</code></summary>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-169">169</a></span>
<span class="normal"><a href="#__codelineno-0-170">170</a></span>
<span class="normal"><a href="#__codelineno-0-171">171</a></span>
<span class="normal"><a href="#__codelineno-0-172">172</a></span>
<span class="normal"><a href="#__codelineno-0-173">173</a></span>
<span class="normal"><a href="#__codelineno-0-174">174</a></span>
<span class="normal"><a href="#__codelineno-0-175">175</a></span>
<span class="normal"><a href="#__codelineno-0-176">176</a></span>
<span class="normal"><a href="#__codelineno-0-177">177</a></span>
<span class="normal"><a href="#__codelineno-0-178">178</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-169"><a id="__codelineno-0-169" name="__codelineno-0-169"></a><span class="k">class</span> <span class="nc">InfoBoxControl</span><span class="p">(</span><span class="n">Control</span><span class="p">):</span>
</span><span id="__span-0-170"><a id="__codelineno-0-170" name="__codelineno-0-170"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;InfoBox control</span>
</span><span id="__span-0-171"><a id="__codelineno-0-171" name="__codelineno-0-171"></a>
</span><span id="__span-0-172"><a id="__codelineno-0-172" name="__codelineno-0-172"></a><span class="sd"> Attributes:</span>
</span><span id="__span-0-173"><a id="__codelineno-0-173" name="__codelineno-0-173"></a><span class="sd"> content (str): Content (HTML or plain text) to be displayed in the info box.</span>
</span><span id="__span-0-174"><a id="__codelineno-0-174" name="__codelineno-0-174"></a><span class="sd"> css_text (str): Optional inline style declaration of the control.</span>
</span><span id="__span-0-175"><a id="__codelineno-0-175" name="__codelineno-0-175"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-176"><a id="__codelineno-0-176" name="__codelineno-0-176"></a>
</span><span id="__span-0-177"><a id="__codelineno-0-177" name="__codelineno-0-177"></a> <span class="n">content</span><span class="p">:</span> <span class="nb">str</span>
</span><span id="__span-0-178"><a id="__codelineno-0-178" name="__codelineno-0-178"></a> <span class="n">css_text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">serialization_alias</span><span class="o">=</span><span class="s2">&quot;cssText&quot;</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
</details>



<div class="doc doc-children">











</div>

</div>


</div>

<div class="doc doc-object doc-class">



<h2 id="maplibre.controls.LayerSwitcherControl" class="doc doc-heading">
<code>maplibre.controls.LayerSwitcherControl</code>


</h2>


<div class="doc doc-contents first">
<p class="doc doc-class-bases">
Bases: <code><span title="maplibre.controls.Control">Control</span></code></p>


<p>Layer switcher control</p>



<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="maplibre.controls.LayerSwitcherControl.layer_ids">layer_ids</span></code></td>
<td>
<code>list</code>
</td>
<td>
<div class="doc-md-description">
<p>A list of layer ids to be shown in the layer switcher control.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="maplibre.controls.LayerSwitcherControl.theme">theme</span></code></td>
<td>
<code><span title="typing.Literal">Literal</span>[&#39;default&#39;, &#39;simple&#39;]</code>
</td>
<td>
<div class="doc-md-description">
<p>The theme of the layer switcher control.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="maplibre.controls.LayerSwitcherControl.css_text">css_text</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional inline style declaration of the control.</p>
</div>
</td>
</tr>
</tbody>
</table>

<details class="quote">
<summary>Source code in <code>maplibre/controls.py</code></summary>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-155">155</a></span>
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
<span class="normal"><a href="#__codelineno-0-160">160</a></span>
<span class="normal"><a href="#__codelineno-0-161">161</a></span>
<span class="normal"><a href="#__codelineno-0-162">162</a></span>
<span class="normal"><a href="#__codelineno-0-163">163</a></span>
<span class="normal"><a href="#__codelineno-0-164">164</a></span>
<span class="normal"><a href="#__codelineno-0-165">165</a></span>
<span class="normal"><a href="#__codelineno-0-166">166</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-155"><a id="__codelineno-0-155" name="__codelineno-0-155"></a><span class="k">class</span> <span class="nc">LayerSwitcherControl</span><span class="p">(</span><span class="n">Control</span><span class="p">):</span>
</span><span id="__span-0-156"><a id="__codelineno-0-156" name="__codelineno-0-156"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Layer switcher control</span>
</span><span id="__span-0-157"><a id="__codelineno-0-157" name="__codelineno-0-157"></a>
</span><span id="__span-0-158"><a id="__codelineno-0-158" name="__codelineno-0-158"></a><span class="sd"> Attributes:</span>
</span><span id="__span-0-159"><a id="__codelineno-0-159" name="__codelineno-0-159"></a><span class="sd"> layer_ids (list): A list of layer ids to be shown in the layer switcher control.</span>
</span><span id="__span-0-160"><a id="__codelineno-0-160" name="__codelineno-0-160"></a><span class="sd"> theme (Literal[&quot;default&quot;, &quot;simple&quot;]): The theme of the layer switcher control.</span>
</span><span id="__span-0-161"><a id="__codelineno-0-161" name="__codelineno-0-161"></a><span class="sd"> css_text (str): Optional inline style declaration of the control.</span>
</span><span id="__span-0-162"><a id="__codelineno-0-162" name="__codelineno-0-162"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-163"><a id="__codelineno-0-163" name="__codelineno-0-163"></a>
</span><span id="__span-0-164"><a id="__codelineno-0-164" name="__codelineno-0-164"></a> <span class="n">layer_ids</span><span class="p">:</span> <span class="nb">list</span> <span class="o">=</span> <span class="n">Field</span><span class="p">([],</span> <span class="n">serialization_alias</span><span class="o">=</span><span class="s2">&quot;layerIds&quot;</span><span class="p">)</span>
</span><span id="__span-0-165"><a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="n">theme</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;default&quot;</span><span class="p">,</span> <span class="s2">&quot;simple&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default&quot;</span>
</span><span id="__span-0-166"><a id="__codelineno-0-166" name="__codelineno-0-166"></a> <span class="n">css_text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">serialization_alias</span><span class="o">=</span><span class="s2">&quot;cssText&quot;</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
</details>



<div class="doc doc-children">











</div>

</div>
Expand Down
Loading

0 comments on commit a38cd8c

Please sign in to comment.