Commit Graph

521 Commits

Author SHA1 Message Date
Peter Robins
17b4cea96d Document Map.render() and Map.renderSync() 2014-06-02 06:21:54 -04:00
Hadrien Tulipe
0bae61ffe3 Rename Map.DEFAULT_RENDER_HINTS to Map.DEFAULT_RENDERER_TYPES 2014-05-27 22:47:02 +02:00
Hadrien Tulipe
7aab28afcc Provide ol.RendererType structure through ol.renderer.Map
It was previously in ol.Map, but it could not be provided because
of circular dependencies.
2014-05-27 22:47:02 +02:00
Hadrien Tulipe
2e587c1be8 Rename ol.RendererHint to ol.RendererType 2014-05-27 22:47:02 +02:00
Hadrien Tulipe
1d6f9ca80b Expose the map renderer type to the public API
In the case  where the map decides itself which renderer to use. It can
be convenient for the developer to have knowledge of the choice made.
2014-05-27 22:47:02 +02:00
Andreas Hocevar
eb6a938062 Do not document object literals as interfaces
Instead, object literals with properties that should not be
renamed can go in externs/olx.js.
2014-05-22 15:48:47 +02:00
Andreas Hocevar
b2805c58de Better document which events are fired
The map does not fire ol.render.Event#render. Change events are
now only listed for classes that fire them, and a description
about when they are fired is added.
2014-05-15 20:28:09 +02:00
Tim Schaub
3a0efe83c5 Update map example 2014-05-14 15:11:12 -06:00
Tim Schaub
df05e9da11 Fire moveend only once after view settles 2014-05-14 14:23:31 -06:00
Andreas Hocevar
8ee9f7cb6a Simplify the way we annotate observable properties
We no longer add observable annotations to the constructor.
Instead, we just mark getters (and for read/write properties
also setters) with an observable annotation.
2014-05-03 16:04:25 -04:00
Andreas Hocevar
0f072c0ec1 List subclasses for each class
With this change, we no longer need to link to implementations
or subclasses manually.
2014-05-03 15:32:39 -04:00
Andreas Hocevar
7271b50d5a Simplify fires annotations 2014-05-01 22:17:56 +02:00
Andreas Hocevar
fbdbbfb7a7 Get rid of stability annotations and document stability with api
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00
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