Commit Graph

408 Commits

Author SHA1 Message Date
Andreas Hocevar
c17ac0cae3 Greatly simplify and document the usage of JSDoc
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.

As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.

This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
Éric Lemoine
f9c0f12f23 Remove skippeFeatures collection 2014-04-24 20:58:50 +02:00
Éric Lemoine
4e965123c8 Make handling of skipped features faster 2014-04-18 10:52:20 +02:00
Tim Schaub
7826036307 Make getLayerStatesArray return an array of layer states 2014-04-04 07:39:54 -06:00
Tim Schaub
78324fb54b Remove layers array from frame state 2014-04-04 07:36:42 -06:00
Tim Schaub
aa3a20e911 Provide layer states array in frame state 2014-04-04 07:36:42 -06:00
Tim Schaub
5653d57712 Change default renderer to Canvas 2014-04-02 11:43:20 -06:00
Frederic Junod
849b534159 Stop 'mouseweel' events in ol-overlaycontainer-stopevent div 2014-04-01 09:42:08 +02:00
Frederic Junod
13224fd479 Use ol.MapBrowserEvent.EventType.POINTERDOWN
Instaed of a hardcoded string
2014-04-01 09:35:34 +02:00
Andreas Hocevar
b59fa4e8af Merge pull request #1898 from ahocevar/events
Document events
2014-03-26 14:13:59 +01:00
ahocevar
a3b5376520 Add missing event documentation and stability tags 2014-03-26 14:04:58 +01:00
ahocevar
7e850ca33d Use JSDoc's stock event documentation 2014-03-25 18:21:08 +01:00
ahocevar
f37245963c Document Map events 2014-03-24 21:53:42 +01:00
Tom Payne
35dea5e3a6 Always use === to compare with 0 2014-03-23 18:29:47 +01:00
Éric Lemoine
3b642ae549 Remove the getSkippedFeatureUids function 2014-03-20 13:30:45 +01:00
Éric Lemoine
c4b654b26c Rename skippedFeaturesHash to skippedFeatureUids 2014-03-20 13:29:30 +01:00
Éric Lemoine
71484d9a53 Better API doc strings in ol.Map 2014-03-20 13:25:20 +01:00
Éric Lemoine
435e5e6916 Better type checking in ol.Map 2014-03-20 13:19:54 +01:00
Antoine Abt
78039aceb8 Use a hash to store features uids 2014-03-20 13:03:31 +01:00
Antoine Abt
d0f2dd354b Trigger render on skippedFeatures change 2014-03-20 10:25:45 +01:00
Antoine Abt
0d87516135 Map stores skippedFeatures instead of layers 2014-03-19 17:24:58 +01:00
tsauerwein
599de6a44a Listen also to pointerdown on overlay container 2014-03-14 10:16:27 +01:00
Tom Payne
022a7a03e0 Use oli.FrameState instead of ol.FrameState 2014-03-10 14:48:23 +01:00
Frederic Junod
f0f2a2d2b0 Set control map in 'add' and 'remove' event handler 2014-03-06 09:03:38 +01:00
Frederic Junod
3dc9d296eb Set interaction map in 'add' and 'remove' event handler 2014-03-06 09:01:50 +01:00
Frederic Junod
9d8243a772 Set overlay map in 'add' and 'remove' event handler 2014-03-06 09:00:00 +01:00
Tom Payne
9a7261d6b3 Remove ol.Map#withFrozenRendering 2014-02-27 19:01:39 +01:00
Tom Payne
dd83952c28 Make renderSync always force a render 2014-02-27 18:59:05 +01:00
Tom Payne
443e7d9a8c Add ol.Map#isRendered 2014-02-20 19:56:22 +01:00
Tom Payne
316c146613 Switch to asynchronous rendering by default 2014-02-20 19:42:00 +01:00
Tom Payne
a8f932fa07 Rename ol.Map#requestRenderFrame to ol.Map#render 2014-02-20 16:54:20 +01:00
Tom Payne
ebdb5dce22 Rename ol.Map#render to ol.Map#renderSync 2014-02-20 03:05:31 +01:00
Antoine Abt
04f1f2120b Merge pull request #1697 from tonio/remove_renderer_guess
Remove `ol.RendererHints.createFromQueryData` from the library
2014-02-17 08:21:18 +01:00
Antoine Abt
4dd8c248f5 Remove ol.RendererHints.createFromQueryData 2014-02-14 09:32:14 +01:00
ahocevar
adad57d481 Make the default effectively truthy 2014-02-13 22:52:48 +01:00
ahocevar
aa5a08a377 No typecast needed 2014-02-13 22:29:20 +01:00
ahocevar
3cc1dad2e0 Make loading parameters configurable 2014-02-13 22:08:26 +01:00
ahocevar
877e881a52 Do not load tiles while interacting
Especially on mobile devices, loading just a single tile can
cause major janks. During animations, it is fine to just skip
frames. But during user interaction (e.g. dragging), a more
instant visual feedback is desirable.
2014-02-13 21:03:21 +01:00
Éric Lemoine
09beba69ad Remove the map renderers option 2014-02-06 16:56:15 +01:00
Éric Lemoine
a91e6e2442 Accept string for keyboardEventTarget option 2014-02-04 15:48:44 +01:00
Éric Lemoine
cf5aada8cf Add a keyboardEventTarget option to the map
This option allows specifying the element to listen to keyboard events on.
2014-02-04 15:46:50 +01:00
Tom Payne
6455c920f6 Make ol.Map#isDef checking stricter 2014-02-04 11:47:49 +01:00
Tom Payne
c5dd7988c9 Use ol.ENABLE_* to help Compiler eliminate unreachable code 2014-01-30 11:20:59 +01:00
Tom Payne
18bbf5bcec Improve type checking in ol.Map 2014-01-30 11:20:59 +01:00
Tom Payne
318fc68159 Convert ol.MapBrowserEvent#get* methods into properties 2014-01-29 14:51:27 +01:00
Éric Lemoine
e83ec2976f Change forEachFeatureAtPixel arguments names 2014-01-17 11:38:06 +01:00
Tom Payne
010f643f8f Use opt_this instead of opt_obj in ol.Map 2014-01-15 14:52:53 +01:00
Tom Payne
4667dec7c3 Rename devicePixelRatio to pixelRatio in ol.FrameState 2014-01-15 09:46:27 +01:00
Éric Lemoine
e76ec3b292 Merge pull request #1504 from elemoine/vector-api-image-vector-hit-detection
[vector-api] Vector image hit detection
2014-01-14 03:33:47 -08:00