Commit Graph

39 Commits

Author SHA1 Message Date
simonseyock
52e06a8ff7 Making ol.Overlay accept offset values if positioning right or bottom
When ol.Overlay has set positioning is set to right or bottom, no offset is applied. I added the missing calculations.
I made 2 fiddles showing the bahaviour before and after.
The divs in hte fiddles are named after their positioning (anchor point)! Not the actual position!
Before: http://jsfiddle.net/simon_seyock/ob7ggtx6/
As you can see, on div named "bottom-right" no offset at all is applied. On "bottom-center" it is only applied horizontally and on "center-right" only vertically.
After: http://jsfiddle.net/simon_seyock/sL2f3nL9/2/
All offsets are applied correctly, you could draw a straight line through the anchor points of every div.
2014-08-25 16:55:33 +02:00
Éric Lemoine
879ace1c9a Add @api stable annotations for ol.Overlay 2014-08-19 12:32:01 +02:00
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
af78adb417 Make ol.Overlay always call setPositioning 2014-06-19 10:09:57 +02:00
Éric Lemoine
0a0d12ec8a Make ol.Overlay always call setOffset 2014-06-19 10:09:37 +02:00
Éric Lemoine
d1d8d5f96c Add an offset property to ol.Overlay
Replaces "offsetX" and "offsetY" by an ol.Object "offset" property.
2014-06-18 22:11:07 +02:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04: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
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
Bart van den Eijnden
83bf626e03 Mark parts of control and overlay as stable 2014-03-17 11:06:46 +01:00
Bart van den Eijnden
731e37349e Combine offsetX and offsetY with positioning 2014-03-13 15:34:45 +01:00
Bart van den Eijnden
3fe3beb28a Add offsetX and offsetY config options for ol.Overlay 2014-03-13 15:06:02 +01:00
Tom Payne
c4786304b7 Only render overlays if the map is rendered 2014-02-20 19:56:42 +01:00
Tom Payne
dc2bb57d18 Allow ol.Overlay positioning option to be a string 2014-02-06 22:33:32 +01:00
Tom Payne
4beb48fa3d Assert that pixel is non-null when positioning overlay 2014-02-04 11:47:49 +01:00
Éric Lemoine
315c42f0a7 Use olx namespace for options types in source code
sed command used: find src/ol -name '*.js' -exec sed -ri 's/\{ol(\.(\w|\.)+Options\=?\})/{olx\1/' \{\} \;
2013-12-12 15:02:03 +01:00
Paul Spencer
5af671b5f7 Merge pull request #1181 from pagameba/doc-observables
Add `@todo observable` documentation for observable properties
2013-10-31 10:51:20 -07:00
Éric Lemoine
16b817b830 Overlay stopEvent and insertFirst default to true 2013-10-30 09:49:38 +01:00
Bruno Binet
71097d9cfc Insert or append overlay based on insertFirst option
This is to fix z-index issues with overlays that pass above ol3 default
controls.
2013-10-30 09:28:25 +01:00
Paul Spencer
4e657e464c Add @todo observable documentation for observable properties
This PR adds documentation for observable properties, which will then be pulled into the docs correctly once #1180 is merged.  This is a first pass based on searching for definition of observable properties being defined as enums after lines ending with `Property = {`.  If there are observable properties implemented that don't follow this pattern then they are not included.

I've added simple descriptions based on what I know or could easily figure out, there may be some properties (like preload) that are not correctly described.

I've also added `readonly` annotations where I knew that a property was readonly.  I may have missed some readonly properties.

ol.layer.Base has a bunch of properties but I don't think it is exported so the documentation of these properties will not show up, so I added the documentation to ol.layer.Layer instead even though this isn't really where it should be documented.
2013-10-29 10:24:54 -04:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Éric Lemoine
63c9aed620 Merge pull request #1077 from ThomasG77/setPositioning
Export ol.Overlay#setPositioning
2013-10-16 02:50:38 -07:00
Bruno Binet
caf958826d Add new container which don't stop event propagation
and allow overlays to optionnally stop event propagation
2013-10-11 12:16:56 +02:00
Bruno Binet
29076db6ed Add support for ol.overlay center positioning 2013-10-07 16:41:59 +02:00
Thomas
817a8feac9 SetPositioning exposition in the API
The method in ol.Overlay is not exposed whereas is equivalent
getter getPositioning is visible in API and documentation.
The PR add a line of description to the documentation and expose
the method
2013-09-30 23:34:51 +02:00
Frederic Junod
ef929e9a72 Fix jsdoc formating 2013-09-24 12:18:00 +02:00
Éric Lemoine
7e25ecb3dc Remove map from OverlayOptions 2013-09-02 14:15:11 +02:00
Tom Payne
88ccf64379 Add missing private member 2013-07-22 18:22:58 +02:00
Tom Payne
46d16ba0ca Use setElementShown instead of showElement 2013-07-22 17:42:47 +02:00
Bart van den Eijnden
8dc97790bc Add more content for the API doc
Involves additions to (there will be subsequent pull requests for other
classes):
- ol.Attribution
- ol.Collection
- ol.Expression
- ol.Feature
- ol.Geolocation
- ol.Map
- ol.Object
- ol.Overlay
- ol.Projection
- ol.View2D
- ol.control.Attribution
- ol.control.Control
- ol.control.FullScreen
- ol.control.Logo
- ol.control.MousePosition
- ol.control.ScaleLine
- ol.control.Zoom
- ol.control.ZoomSlider
- ol.dom.Input
- ol.filter.Filter
- ol.filter.Geometry
- ol.filter.Logical
2013-06-11 20:56:04 +02:00
Frederic Junod
a1a7e21f92 Redefine ol.Size to be Array.<number> 2013-06-01 10:22:06 +02:00
Frederic Junod
be081fd44e Redefine ol.Pixel to be Array.<number> 2013-05-31 15:53:04 +02:00
Frederic Junod
984002a7ec Change ol.Object event name syntax
'changed' to 'change' and '<attribute>_changed' to 'change:<attribute>'.
2013-05-31 12:38:37 +02:00
Tom Payne
3f637ec2c4 Be more consistent with overlay options 2013-04-07 11:44:58 +02:00
Tom Payne
4be8c991f7 Add missing Closure Library requires 2013-04-06 14:28:12 +02:00
Tom Payne
096d48b4e8 Rename AnchoredElement to Overlay 2013-03-24 20:30:12 +01:00