From 42abdb308ae3aba70fd20654d9b6b009f7110aa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Sat, 6 Jul 2013 21:33:59 +0200 Subject: [PATCH] Better docs for View2DOptions --- src/objectliterals.jsdoc | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 9fe757271c..215f8d1328 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -88,21 +88,33 @@ /** * Object literal with config options for the view. * @typedef {Object} ol.View2DOptions - * @property {ol.Coordinate|undefined} center The view center in map projection. - * @property {number|undefined} maxResolution The maximum resolution in map - * units per pixel. - * @property {number|undefined} maxZoom The maximum zoom level for this view. - * Zoom level 0 uses the `maxResolution`; subsequent zoom levels are - * calculated by dividing the previous resolution by `zoomFactor`. - * @property {ol.ProjectionLike} projection The map projection. + * @property {ol.Coordinate|undefined} center The initial center for the view. + * The coordinate system for the center is specified with the `projection` + * option. + * @property {number|undefined} maxResolution The maximum resolution used to + * determine the resolution constraint. It is used together with `maxZoom` + * and `zoomFactor`. If unspecified it is calculated in such a way that the + * projection's validity extent fits in a 256x256 px tile. If the projection + * is Spherical Mercator (the default) then `maxResolution` defaults to + * 40075016.68557849 / 256 = 156543.03392804097. + * @property {number|undefined} maxZoom The maximum zoom level used to determine + * the resolution constraint. It is used together with `maxResolution` and + * `zoomFactor`. Default is 28. + * @property {ol.ProjectionLike} projection The projection. Default is + * `EPSG:3857` (Spherical Mercator). * @property {number|undefined} resolution The initial resolution for the view. - * @property {Array.|undefined} resolutions The resolutions for this - * view. If configured, this is equivalent to specifying `maxResolution` and - * `maxZoom`. - * @property {number|undefined} rotation Initial rotation of the view. - * @property {number|undefined} zoom Initial zoom level of the view. - * @property {number|undefined} zoomFactor Factor to calculate resolutions for - * zoom levels. Default is 2. + * The units are `projection` units per pixel (e.g. meters per pixel). + * @property {Array.|undefined} resolutions Resolutions to determine the + * resolution constraint. If set the `maxResolution`, `maxZoom` and + * `zoomFactor` options are ignored. + * @property {number|undefined} rotation The initial rotation for the view + * in radians (positive rotation clockwise). + * @property {number|undefined} zoom Zoom level used to calculate the initial + * resolution for the view. The initial resolution is determined using the + * `ol.View2D#constrainResolution` method. + * @property {number|undefined} zoomFactor The zoom factor used to determine the + * resolution constraint. It is together with `maxResolution` and `maxZoom`. + * Default is 2. */ /**