Skip to content

Commit 909536f

Browse files
committed
Website updates
1 parent ce7106c commit 909536f

37 files changed

+635
-61
lines changed

dist/en/main/apidoc/module-ol_interaction_Extent-Extent.html

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ <h2 class="my-3">
137137

138138
<div class="class-description col-lg-7 align-self-center ps-0"><p>Allows the user to draw a vector box by clicking and dragging on the map.
139139
Once drawn, the vector box can be modified by dragging its vertices or edges.
140-
This interaction is only supported for mouse devices.</p></div>
140+
The interaction can also be configured with an initial extent and a <code>createCondition</code>
141+
to prevent the creation of a new extent on <code>pointerdown</code>, if desired.</p></div>
141142

142143
</div>
143144
</header>
@@ -163,7 +164,7 @@ <h4 class="name">
163164

164165
<div class="tag-source">
165166
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
166-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L99">line 99</a>
167+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L105">line 105</a>
167168
</div>
168169

169170
</div>
@@ -228,6 +229,66 @@ <h4 class="name">
228229

229230

230231

232+
<tr class="">
233+
234+
<td class="name"><code>createCondition</code></td>
235+
236+
237+
238+
<td class="type">
239+
240+
241+
<span class="param-type"><a href="module-ol_events_condition.html#~Condition">Condition</a></span>
242+
|
243+
244+
<span class="param-type">null</span>
245+
246+
247+
248+
(defaults to null)
249+
250+
251+
</td>
252+
253+
254+
255+
<td class="description last">
256+
257+
<p>A function that
258+
takes a <a href="module-ol_MapBrowserEvent-MapBrowserEvent.html"><code>MapBrowserEvent</code></a> and returns a
259+
boolean to indicate whether that event should be handled to create a new extent.
260+
If <code>null</code>, the <code>condition</code> will also be used as <code>createCondition</code>.</p></td>
261+
</tr>
262+
263+
264+
265+
<tr class="">
266+
267+
<td class="name"><code>drag</code></td>
268+
269+
270+
271+
<td class="type">
272+
273+
274+
<span class="param-type">boolean</span>
275+
276+
277+
278+
(defaults to false)
279+
280+
281+
</td>
282+
283+
284+
285+
<td class="description last">
286+
287+
<p>An extent can be dragged.</p></td>
288+
</tr>
289+
290+
291+
231292
<tr class="">
232293

233294
<td class="name"><code>extent</code></td>
@@ -1004,7 +1065,7 @@ <h4 class="name">
10041065

10051066
<div class="tag-source">
10061067
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
1007-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L450">line 450</a>
1068+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L508">line 508</a>
10081069
</div>
10091070

10101071
</div>
@@ -1094,7 +1155,7 @@ <h4 class="name">
10941155

10951156
<div class="tag-source">
10961157
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
1097-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L463">line 463</a>
1158+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L522">line 522</a>
10981159
</div>
10991160

11001161
</div>
@@ -1128,6 +1189,8 @@ <h4 class="name">
11281189

11291190

11301191

1192+
<dt class="important tag-deprecated">Deprecated</dt><dd><ul class="dummy"><li>Use <a href="module-ol_interaction_Extent-Extent.html#getExtent"><code>getExtent</code></a> instead.</li><ul></dd>
1193+
11311194

11321195

11331196

@@ -2286,7 +2349,7 @@ <h4 class="name">
22862349

22872350
<div class="tag-source">
22882351
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
2289-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L473">line 473</a>
2352+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L532">line 532</a>
22902353
</div>
22912354

22922355
</div>

dist/en/main/apidoc/module-ol_interaction_Extent.ExtentEvent.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ <h4 class="name">
717717

718718
<div class="tag-source">
719719
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
720-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L47">line 47</a>
720+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L52">line 52</a>
721721
</div>
722722

723723
</div>

dist/en/main/apidoc/module-ol_interaction_Extent.html

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,62 @@ <h5 class="subsection-title">Properties:</h5>
231231

232232

233233

234+
<tr>
235+
236+
<td class="name"><code>createCondition</code></td>
237+
238+
239+
<td class="type">
240+
241+
242+
<span class="param-type"><a href="module-ol_events_condition.html#~Condition">Condition</a></span>
243+
|
244+
245+
<span class="param-type">null</span>
246+
247+
248+
249+
<br>(defaults to null)
250+
251+
252+
</td>
253+
254+
<td class="description last">
255+
<p>A function that
256+
takes a <a href="module-ol_MapBrowserEvent-MapBrowserEvent.html"><code>MapBrowserEvent</code></a> and returns a
257+
boolean to indicate whether that event should be handled to create a new extent.
258+
If <code>null</code>, the <code>condition</code> will also be used as <code>createCondition</code>.</p>
259+
260+
</td>
261+
</tr>
262+
263+
264+
265+
<tr>
266+
267+
<td class="name"><code>drag</code></td>
268+
269+
270+
<td class="type">
271+
272+
273+
<span class="param-type">boolean</span>
274+
275+
276+
277+
<br>(defaults to false)
278+
279+
280+
</td>
281+
282+
<td class="description last">
283+
<p>An extent can be dragged.</p>
284+
285+
</td>
286+
</tr>
287+
288+
289+
234290
<tr>
235291

236292
<td class="name"><code>extent</code></td>
@@ -400,7 +456,7 @@ <h4 class="name">
400456

401457
<div class="tag-source">
402458
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js">interaction/Extent.js</a>,
403-
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L76">line 76</a>
459+
<a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Extent.js#L81">line 81</a>
404460
</div>
405461

406462
</div>

dist/en/main/examples/box-selection.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,11 @@ <h4 id="title">Box Selection</h4>
127127
data-content="&lt;ul class=&quot;list-group&quot;&gt;
128128
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action active&quot; href=&quot;./box-selection.html&quot;&gt;Box Selection&lt;/a&gt;
129129
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction.html&quot;&gt;Extent Interaction&lt;/a&gt;
130+
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction-modify.html&quot;&gt;Modify an extent&lt;/a&gt;
130131
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./rectangle.html&quot;&gt;Rectangle&lt;/a&gt;
131132
&lt;/ul&gt;"
132133
tabindex="0"
133-
>3</a>
134+
>4</a>
134135
</span>
135136
</p>
136137
<div class="modal modal-tag-example" id="tag-example-list" tabindex="-1" role="dialog" aria-labelledby="tag-example-title" aria-hidden="true">

dist/en/main/examples/common.js

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/en/main/examples/common.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/en/main/examples/custom-interactions.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,11 @@ <h4 id="title">Custom Interactions</h4>
248248
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./double-click-drag-zoom.html&quot;&gt;Double click, Drag and Zoom&lt;/a&gt;
249249
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./drag-rotate-and-zoom.html&quot;&gt;Drag, Rotate, and Zoom&lt;/a&gt;
250250
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction.html&quot;&gt;Extent Interaction&lt;/a&gt;
251+
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction-modify.html&quot;&gt;Modify an extent&lt;/a&gt;
251252
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./pinch-zoom.html&quot;&gt;Pinch Zoom&lt;/a&gt;
252253
&lt;/ul&gt;"
253254
tabindex="0"
254-
>5</a>
255+
>6</a>
255256
</span>
256257
</p>
257258
<div class="modal modal-tag-example" id="tag-example-list" tabindex="-1" role="dialog" aria-labelledby="tag-example-title" aria-hidden="true">

dist/en/main/examples/double-click-drag-zoom.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,11 @@ <h4 id="title">Double click, Drag and Zoom</h4>
157157
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action active&quot; href=&quot;./double-click-drag-zoom.html&quot;&gt;Double click, Drag and Zoom&lt;/a&gt;
158158
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./drag-rotate-and-zoom.html&quot;&gt;Drag, Rotate, and Zoom&lt;/a&gt;
159159
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction.html&quot;&gt;Extent Interaction&lt;/a&gt;
160+
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction-modify.html&quot;&gt;Modify an extent&lt;/a&gt;
160161
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./pinch-zoom.html&quot;&gt;Pinch Zoom&lt;/a&gt;
161162
&lt;/ul&gt;"
162163
tabindex="0"
163-
>5</a>
164+
>6</a>
164165
</span>
165166
</p>
166167
<div class="modal modal-tag-example" id="tag-example-list" tabindex="-1" role="dialog" aria-labelledby="tag-example-title" aria-hidden="true">

dist/en/main/examples/drag-rotate-and-zoom.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,11 @@ <h4 id="title">Drag, Rotate, and Zoom</h4>
131131
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./double-click-drag-zoom.html&quot;&gt;Double click, Drag and Zoom&lt;/a&gt;
132132
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action active&quot; href=&quot;./drag-rotate-and-zoom.html&quot;&gt;Drag, Rotate, and Zoom&lt;/a&gt;
133133
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction.html&quot;&gt;Extent Interaction&lt;/a&gt;
134+
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction-modify.html&quot;&gt;Modify an extent&lt;/a&gt;
134135
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./pinch-zoom.html&quot;&gt;Pinch Zoom&lt;/a&gt;
135136
&lt;/ul&gt;"
136137
tabindex="0"
137-
>5</a>
138+
>6</a>
138139
</span>
139140
</p>
140141
<div class="modal modal-tag-example" id="tag-example-list" tabindex="-1" role="dialog" aria-labelledby="tag-example-title" aria-hidden="true">

dist/en/main/examples/draw-and-modify-features.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,15 @@ <h4 id="title">Draw and Modify Features</h4>
130130
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./draw-and-modify-geodesic.html&quot;&gt;Draw and Modify Geodesic Circles&lt;/a&gt;
131131
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./modify-icon.html&quot;&gt;Icon modification&lt;/a&gt;
132132
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./measure-style.html&quot;&gt;Measure using vector styles&lt;/a&gt;
133+
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./extent-interaction-modify.html&quot;&gt;Modify an extent&lt;/a&gt;
133134
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./modify-features.html&quot;&gt;Modify Features&lt;/a&gt;
134135
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./modify-test.html&quot;&gt;Modify Features Test&lt;/a&gt;
135136
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./modify-scale-and-rotate.html&quot;&gt;Scale and Rotate using Modify Interaction&lt;/a&gt;
136137
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./snap.html&quot;&gt;Snap Interaction&lt;/a&gt;
137138
&lt;li&gt;&lt;a class=&quot;list-group-item list-group-item-action&quot; href=&quot;./snap-custom-segmenter.html&quot;&gt;Snap Interaction with Custom Segmenter&lt;/a&gt;
138139
&lt;/ul&gt;"
139140
tabindex="0"
140-
>9</a>
141+
>10</a>
141142
</span>
142143
<span class="badge-group">
143144
<a

0 commit comments

Comments
 (0)