Skip to content
This repository was archived by the owner on Oct 1, 2019. It is now read-only.

Commit 1e053dd

Browse files
committed
fix jsdoc and README
1 parent cbe5f84 commit 1e053dd

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# ol3-popup-umd
44

55
Basic popup for an OpenLayers 3 map. By default the map is centered so that the popup is entirely visible.
6-
This project originally forked from [ol3-popup](https://github.com/walkermatt/ol3-popup) by Matt Walker.
6+
This project originally forked from [ol3-popup](https://github.com/walkermatt/ol3-popup) by Matt Walker
7+
and extended with new features like event emitting, additional methods and others, also packed as UMD package.
78

89
## Installation
910

dist/bundle.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -204,16 +204,16 @@ return /******/ (function(modules) { // webpackBootstrap
204204
* A positive value shifts the overlay down. Default is `[0, 0]`.
205205
* @property {ol.Coordinate | undefined} position The overlay position in map projection.
206206
* @property {ol.OverlayPositioning | string | undefined} positioning Defines how the overlay is actually positioned with respect to its position property.
207-
* Possible values are `'bottom-left', 'bottom-center', 'bottom-right', 'center-left',
208-
* 'center-center', 'center-right', 'top-left', 'top-center', and 'top-right'.
209-
* Default is 'top-left'`.
207+
* Possible values are `bottom-left`, `bottom-center`, `bottom-right`, `center-left`,
208+
* `center-center`, `center-right`, `top-left`, `top-center`, and `top-right`.
209+
* Default is `top-left`.
210210
* @property {boolean | undefined} stopEvent Whether event propagation to the map viewport should be stopped. Default is `true`.
211211
* If true the overlay is placed in the same container as that of the controls (CSS class name `ol-overlaycontainer-stopevent`);
212212
* if false it is placed in the container with CSS class name `ol-overlaycontainer`.
213213
* @property {boolean | undefined} insertFirst Whether the overlay is inserted first in the overlay container, or appended.
214214
* Default is `true`. If the overlay is placed in the same container as that of the controls
215-
* (see the stopEvent option) you will probably set `insertFirst` to true so the overlay is displayed below the controls.
216-
* @property {boolean | undefined} autoPan If set to true the map is panned when calling setPosition, so that the overlay is entirely visible in the current viewport.
215+
* (see the `stopEvent` option) you will probably set `insertFirst` to true so the overlay is displayed below the controls.
216+
* @property {boolean | undefined} autoPan If set to `true` the map is panned when calling `setPosition`, so that the overlay is entirely visible in the current viewport.
217217
* The default is `true`.
218218
* @property {olx.animation.PanOptions | undefined} autoPanAnimation The options used to create a `ol.animation.pan` animation.
219219
* This animation is only used when `autoPan` is enabled.

util/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# ol3-popup-umd
44

55
Basic popup for an OpenLayers 3 map. By default the map is centered so that the popup is entirely visible.
6-
This project originally forked from [ol3-popup](https://github.com/walkermatt/ol3-popup) by Matt Walker.
6+
This project originally forked from [ol3-popup](https://github.com/walkermatt/ol3-popup) by Matt Walker
7+
and extended with new features like event emitting, additional methods and others, also packed as UMD package.
78

89
## Installation
910

0 commit comments

Comments
 (0)