From 1963e6088ec1d102e21db7c430da30ce3f9a7322 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 23 Mar 2018 08:54:55 +0100 Subject: [PATCH 1/3] Fix wrong module name annotation --- src/ol/control.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ol/control.js b/src/ol/control.js index 79587b3d9b..4d57331f29 100644 --- a/src/ol/control.js +++ b/src/ol/control.js @@ -32,7 +32,7 @@ import Zoom from './control/Zoom.js'; * * {@link module:ol/control/Rotate~Rotate} * * {@link module:ol/control/Attribution~Attribution} * - * @param {module:ol/control~DefaultsOptions~DefaultsOptions=} opt_options + * @param {module:ol/control~DefaultsOptions=} opt_options * Defaults options. * @return {module:ol/Collection~Collection.} * Controls. From 29b37b179c1c9185a0d8a605f72d85251e8f9a9f Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 23 Mar 2018 09:14:11 +0100 Subject: [PATCH 2/3] Move olx.ViewState to ol/View --- externs/olx.js | 46 ---------------------------- src/ol/PluggableMap.js | 2 +- src/ol/View.js | 14 +++++++-- src/ol/control/ScaleLine.js | 2 +- src/ol/renderer/canvas/ImageLayer.js | 2 +- src/ol/source/Raster.js | 4 +-- 6 files changed, 17 insertions(+), 53 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 2405a467da..9e3490116d 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -4315,52 +4315,6 @@ olx.tilegrid.XYZOptions.prototype.minZoom; olx.tilegrid.XYZOptions.prototype.tileSize; -/** - * @typedef {{center: ol.Coordinate, - * projection: module:ol/proj/Projection~Projection, - * resolution: number, - * rotation: number, - * zoom: number}} - */ -olx.ViewState; - - -/** - * @type {ol.Coordinate} - * @api - */ -olx.ViewState.prototype.center; - - -/** - * @type {module:ol/proj/Projection~Projection} - * @api - */ -olx.ViewState.prototype.projection; - - -/** - * @type {number} - * @api - */ -olx.ViewState.prototype.resolution; - - -/** - * @type {number} - * @api - */ -olx.ViewState.prototype.rotation; - - -/** - * The current zoom level. - * @type {number} - * @api - */ -olx.ViewState.prototype.zoom; - - /** * @typedef {{initialSize: (number|undefined), * maxSize: (number|undefined), diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index 8c92b2ada8..12d258a4a7 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -37,7 +37,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js * @typedef {Object} FrameState * @property {number} pixelRatio The pixel ratio of the frame. * @property {number} time The time when rendering of the frame was requested. - * @property {olx.ViewState} viewState The state of the current view. + * @property {module:ol/View~State} viewState The state of the current view. * @property {boolean} animate * @property {module:ol/transform~Transform} coordinateToPixelTransform * @property {null|module:ol/extent~Extent} extent diff --git a/src/ol/View.js b/src/ol/View.js index 286d45d254..428ba21612 100644 --- a/src/ol/View.js +++ b/src/ol/View.js @@ -155,6 +155,16 @@ import Units from './proj/Units.js'; */ +/** + * @typedef {Object} State + * @property {module:ol/coordinate~Coordinate} center + * @property {module:ol/proj/Projection~Projection} projection + * @property {number} resolution + * @property {number} rotation + * @property {number} zoom + */ + + /** * Default min zoom level for the map view. * @type {number} @@ -918,14 +928,14 @@ View.prototype.getValueForResolutionFunction = function(opt_power) { /** - * @return {olx.ViewState} View state. + * @return {module:ol/View~State} View state. */ View.prototype.getState = function() { const center = /** @type {module:ol/coordinate~Coordinate} */ (this.getCenter()); const projection = this.getProjection(); const resolution = /** @type {number} */ (this.getResolution()); const rotation = this.getRotation(); - return /** @type {olx.ViewState} */ ({ + return /** @type {module:ol/View~State} */ ({ center: center.slice(), projection: projection !== undefined ? projection : null, resolution: resolution, diff --git a/src/ol/control/ScaleLine.js b/src/ol/control/ScaleLine.js index f4993f30a3..d64cd2b277 100644 --- a/src/ol/control/ScaleLine.js +++ b/src/ol/control/ScaleLine.js @@ -75,7 +75,7 @@ const ScaleLine = function(opt_options) { /** * @private - * @type {?olx.ViewState} + * @type {?module:ol/View~State} */ this.viewState_ = null; diff --git a/src/ol/renderer/canvas/ImageLayer.js b/src/ol/renderer/canvas/ImageLayer.js index 03ecadc457..1390046f73 100644 --- a/src/ol/renderer/canvas/ImageLayer.js +++ b/src/ol/renderer/canvas/ImageLayer.js @@ -154,7 +154,7 @@ CanvasImageLayerRenderer.prototype.prepareFrame = function(frameState, layerStat getWidth(renderedExtent) / viewResolution, getHeight(renderedExtent) / viewResolution ], - viewState: /** @type {olx.ViewState} */ (assign({}, frameState.viewState, { + viewState: /** @type {module:ol/View~State} */ (assign({}, frameState.viewState, { rotation: 0 })) })); diff --git a/src/ol/source/Raster.js b/src/ol/source/Raster.js index 19f99f7493..2076d68fd4 100644 --- a/src/ol/source/Raster.js +++ b/src/ol/source/Raster.js @@ -183,7 +183,7 @@ const RasterSource = function(options) { tileQueue: this.tileQueue_, time: Date.now(), usedTiles: {}, - viewState: /** @type {olx.ViewState} */ ({ + viewState: /** @type {module:ol/View~State} */ ({ rotation: 0 }), viewHints: [], @@ -232,7 +232,7 @@ RasterSource.prototype.updateFrameState_ = function(extent, resolution, projecti const frameState = /** @type {module:ol/PluggableMap~FrameState} */ (assign({}, this.frameState_)); - frameState.viewState = /** @type {olx.ViewState} */ (assign({}, frameState.viewState)); + frameState.viewState = /** @type {module:ol/View~State} */ (assign({}, frameState.viewState)); const center = getCenter(extent); From deb536bfbd0d29c73b21f3df69f286b5f90586e4 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 23 Mar 2018 11:43:29 +0100 Subject: [PATCH 3/3] Refresh externs/xol.js --- externs/xol.js | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/externs/xol.js b/externs/xol.js index 47cfc14ec6..8b6992537d 100644 --- a/externs/xol.js +++ b/externs/xol.js @@ -1,17 +1,4 @@ -/** - * @typedef {Object} layer_BaseOptions - * @property {number|undefined} opacity Opacity (0, 1). Default is `1`. - * @property {boolean|undefined} visible Visibility. Default is `true`. - * @property {ol.Extent|undefined} extent The bounding extent for layer rendering. The layer will not be rendered - * outside of this extent. - * @property {number|undefined} zIndex The z-index for layer rendering. At rendering time, the layers will be - * ordered, first by Z-index and then by position. The default Z-index is 0. - * @property {number|undefined} minResolution The minimum resolution (inclusive) at which this layer will be visible. - * @property {number|undefined} maxResolution The maximum resolution (exclusive) below which this layer will be visible. - */ - - /** * @typedef {Object} layer_LayerOptions * @property {number|undefined} opacity Opacity (0, 1). Default is `1`. @@ -1155,16 +1142,6 @@ */ -/** - * @typedef {Object} ViewState - * @property {ol.Coordinate} center - * @property {module:ol/proj/Projection~Projection} projection - * @property {number} resolution - * @property {number} rotation - * @property {number} zoom The current zoom level. - */ - - /** * @typedef {Object} style_AtlasManagerOptions * @property {number|undefined} initialSize The size in pixels of the first atlas image. Default is `256`.