Commit Graph

441 Commits

Author SHA1 Message Date
Tim Schaub
d99a61545c Use @observable annotation instead of @todo observable 2014-07-05 16:16:44 -04:00
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Éric Lemoine
ade0cd8aaf Merge pull request #2265 from elemoine/setproperties
Change setValues to setProperties
2014-06-29 11:56:17 +02:00
Tim Schaub
2ec63b6c58 Unnecessary ol.Tile requires 2014-06-27 19:57:54 -04:00
Éric Lemoine
eafc2ac371 Change setValues to setProperties 2014-06-27 17:26:51 +02:00
Tim Schaub
e802902f9b Rename ol.extent.getForView2DAndSize to ol.extent.getForViewAndSize 2014-06-27 09:59:39 -04:00
Tim Schaub
47d37fabea Rename ol.View2D to ol.View 2014-06-27 09:59:39 -04:00
Tim Schaub
b9f444a008 Rename olx.View2DState to olx.ViewState and use viewState property 2014-06-27 09:58:25 -04:00
Tim Schaub
2e88f911dd Rename view.getView2DState() to view.getState() 2014-06-27 09:52:19 -04:00
Tim Schaub
b88d2aebc9 Remove view.getView2D() method 2014-06-27 09:52:19 -04:00
Tim Schaub
956e1bf8b4 Remove ol.View base class 2014-06-27 09:52:19 -04:00
Tim Schaub
3c1cb55079 Remove IView and IView2D 2014-06-27 09:52:19 -04:00
Andreas Hocevar
efc3e3244a Merge pull request #2254 from elemoine/replaygroup
Use replay groups for feature overlays
2014-06-27 12:59:06 +02:00
Andreas Hocevar
1551e6e7ff Improved forEatchFeatureAtPixel docs 2014-06-26 15:17:29 +02:00
Éric Lemoine
0762b8c023 Defer selection/deselection 2014-06-26 10:39:58 +02:00
Éric Lemoine
bcdce20ee3 Clone skippedFeatureUids_ 2014-06-25 18:32:08 +02:00
Éric Lemoine
b40a6997d9 Add stable tags to ol.Map 2014-06-19 10:37:11 +02:00
Tim Schaub
2a42e7736a Merge pull request #2178 from probins/classdesc
Use @classdesc notation.
2014-06-09 11:18:14 -06:00
Tim Schaub
ee38f8fc2f Merge pull request #2033 from htulipe/map-renderer-type
Expose map renderer type in the API.
2014-06-06 14:13:50 -06:00
Peter Robins
acd03b0a46 Change @class docs tag to @classdesc 2014-06-06 05:28:24 -04:00
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