From 34d5a38a9eed5d1b533830605792d2a5c17965c9 Mon Sep 17 00:00:00 2001 From: Roman Zoller Date: Fri, 23 Mar 2018 09:49:24 +0100 Subject: [PATCH] Move olx.layer.ImageOptions to ol/layer/Image --- externs/olx.js | 82 ------------------------------------------- src/ol/layer/Image.js | 23 +++++++++++- 2 files changed, 22 insertions(+), 83 deletions(-) diff --git a/externs/olx.js b/externs/olx.js index 31a1c49215..32e6573305 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -5,88 +5,6 @@ let olx; -/** - * @typedef {{opacity: (number|undefined), - * map: (ol.PluggableMap|undefined), - * source: (ol.source.Image|undefined), - * visible: (boolean|undefined), - * extent: (ol.Extent|undefined), - * minResolution: (number|undefined), - * maxResolution: (number|undefined), - * zIndex: (number|undefined)}} - */ -olx.layer.ImageOptions; - - -/** - * Opacity (0, 1). Default is `1`. - * @type {number|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.opacity; - - -/** - * Source for this layer. - * @type {ol.source.Image} - * @api - */ -olx.layer.ImageOptions.prototype.source; - - -/** - * Sets the layer as overlay on a map. The map will not manage this layer in its - * layers collection, and the layer will be rendered on top. This is useful for - * temporary layers. The standard way to add a layer to a map and have it - * managed by the map is to use {@link ol.Map#addLayer}. - * @type {ol.PluggableMap|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.map; - - -/** - * Visibility. Default is `true` (visible). - * @type {boolean|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.visible; - - -/** - * The bounding extent for layer rendering. The layer will not be rendered - * outside of this extent. - * @type {ol.Extent|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.extent; - - -/** - * The minimum resolution (inclusive) at which this layer will be visible. - * @type {number|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.minResolution; - - -/** - * The maximum resolution (exclusive) below which this layer will be visible. - * @type {number|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.maxResolution; - - -/** - * 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. - * @type {number|undefined} - * @api - */ -olx.layer.ImageOptions.prototype.zIndex; - - /** * @typedef {{opacity: (number|undefined), * preload: (number|undefined), diff --git a/src/ol/layer/Image.js b/src/ol/layer/Image.js index bbb1f73f3d..ee965cd1c7 100644 --- a/src/ol/layer/Image.js +++ b/src/ol/layer/Image.js @@ -5,6 +5,27 @@ import {inherits} from '../index.js'; import LayerType from '../LayerType.js'; import Layer from '../layer/Layer.js'; + +/** + * @typedef {Object} Options + * @property {number} [opacity=1] Opacity (0, 1). + * @property {boolean} [visible=true] Visibility. + * @property {ol.Extent} [extent] The bounding extent for layer rendering. The layer will not be + * rendered outside of this extent. + * @property {number} [zIndex=0] The z-index for layer rendering. At rendering time, the layers + * will be ordered, first by Z-index and then by position. + * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be + * visible. + * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will + * be visible. + * @property {ol.PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage + * this layer in its layers collection, and the layer will be rendered on top. This is useful for + * temporary layers. The standard way to add a layer to a map and have it managed by the map is to + * use {@link ol.Map#addLayer}. + * @property {ol.source.Image} [source] Source for this layer. + */ + + /** * @classdesc * Server-rendered images that are available for arbitrary extents and @@ -16,7 +37,7 @@ import Layer from '../layer/Layer.js'; * @constructor * @extends {module:ol/layer/Layer~Layer} * @fires ol.render.Event - * @param {olx.layer.ImageOptions=} opt_options Layer options. + * @param {module:ol/layer/Image~Options=} opt_options Layer options. * @api */ const ImageLayer = function(opt_options) {