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

Commit

Permalink
fix jsdoc and README
Browse files Browse the repository at this point in the history
  • Loading branch information
ghettovoice committed Jul 4, 2016
1 parent cbe5f84 commit 1e053dd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
# ol3-popup-umd

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

## Installation

Expand Down
10 changes: 5 additions & 5 deletions dist/bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,16 +204,16 @@ return /******/ (function(modules) { // webpackBootstrap
* A positive value shifts the overlay down. Default is `[0, 0]`.
* @property {ol.Coordinate | undefined} position The overlay position in map projection.
* @property {ol.OverlayPositioning | string | undefined} positioning Defines how the overlay is actually positioned with respect to its position property.
* Possible values are `'bottom-left', 'bottom-center', 'bottom-right', 'center-left',
* 'center-center', 'center-right', 'top-left', 'top-center', and 'top-right'.
* Default is 'top-left'`.
* Possible values are `bottom-left`, `bottom-center`, `bottom-right`, `center-left`,
* `center-center`, `center-right`, `top-left`, `top-center`, and `top-right`.
* Default is `top-left`.
* @property {boolean | undefined} stopEvent Whether event propagation to the map viewport should be stopped. Default is `true`.
* If true the overlay is placed in the same container as that of the controls (CSS class name `ol-overlaycontainer-stopevent`);
* if false it is placed in the container with CSS class name `ol-overlaycontainer`.
* @property {boolean | undefined} insertFirst Whether the overlay is inserted first in the overlay container, or appended.
* Default is `true`. If the overlay is placed in the same container as that of the controls
* (see the stopEvent option) you will probably set `insertFirst` to true so the overlay is displayed below the controls.
* @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.
* (see the `stopEvent` option) you will probably set `insertFirst` to true so the overlay is displayed below the controls.
* @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.
* The default is `true`.
* @property {olx.animation.PanOptions | undefined} autoPanAnimation The options used to create a `ol.animation.pan` animation.
* This animation is only used when `autoPan` is enabled.
Expand Down
3 changes: 2 additions & 1 deletion util/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
# ol3-popup-umd

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

## Installation

Expand Down

0 comments on commit 1e053dd

Please sign in to comment.