/** * @module ol/layer/Image */ 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 {module:ol/extent~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 {module:ol/PluggableMap~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 {module:ol/source/Image~ImageSource} [source] Source for this layer. */ /** * @classdesc * Server-rendered images that are available for arbitrary extents and * resolutions. * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject} * property on the layer object; for example, setting `title: 'My Title'` in the * options means that `title` is observable, and has get/set accessors. * * @constructor * @extends {module:ol/layer/Layer~Layer} * @fires ol.render.Event * @param {module:ol/layer/Image~Options=} opt_options Layer options. * @api */ const ImageLayer = function(opt_options) { const options = opt_options ? opt_options : {}; Layer.call(this, /** @type {module:ol/layer/Layer~Options} */ (options)); /** * The layer type. * @protected * @type {module:ol/LayerType~LayerType} */ this.type = LayerType.IMAGE; }; inherits(ImageLayer, Layer); /** * Return the associated {@link module:ol/source/Image~ImageSource source} of the image layer. * @function * @return {module:ol/source/Image~ImageSource} Source. * @api */ ImageLayer.prototype.getSource; export default ImageLayer;