Improve the API description for "multiWorld"

The API description for multiWorld seems very vague compared with other view option descriptions and the upgrade notes.
This commit is contained in:
mike-000
2019-09-23 14:15:51 +01:00
committed by GitHub
parent 0bb5a07dee
commit d749e244ed

View File

@@ -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.