From d749e244ed4e3ebd9fd956aed5333882e075cd38 Mon Sep 17 00:00:00 2001 From: mike-000 <49240900+mike-000@users.noreply.github.com> Date: Mon, 23 Sep 2019 14:15:51 +0100 Subject: [PATCH] Improve the API description for "multiWorld" The API description for multiWorld seems very vague compared with other view option descriptions and the upgrade notes. --- src/ol/View.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/ol/View.js b/src/ol/View.js index 4dcef75c9e..e806119a9b 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -120,7 +120,10 @@ import {createMinMaxResolution} from './resolutionconstraint.js'; * resolution constraint. It is used together with `maxZoom` (or * `minResolution`) and `zoomFactor`. Note that if `maxResolution` is also * provided, it is given precedence over `minZoom`. - * @property {boolean} [multiWorld=false] No more than one world is visible. + * @property {boolean} [multiWorld=false] If `false` the view is constrained so + * only one world is visible, and you cannot pan off the edge. If `true` the map + * may show multiple worlds at low zoom levels. Only used if the `projection` is + * global. Note that if `extent` is also provided it is given precedence. * @property {boolean} [constrainResolution=false] If true, the view will always * animate to the closest zoom level after an interaction; false means * intermediary zoom levels are allowed.