/** * @module ol/source/ImageWMS */ var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); import EventType from '../events/EventType.js'; import ImageSource, { defaultImageLoadFunction } from './Image.js'; import ImageWrapper from '../Image.js'; import { DEFAULT_VERSION } from './wms.js'; import { appendParams } from '../uri.js'; import { assert } from '../asserts.js'; import { assign } from '../obj.js'; import { calculateSourceResolution } from '../reproj.js'; import { ceil, floor, round } from '../math.js'; import { compareVersions } from '../string.js'; import { containsExtent, getCenter, getForViewAndSize, getHeight, getWidth, } from '../extent.js'; import { get as getProjection, transform } from '../proj.js'; /** * Number of decimal digits to consider in integer values when rounding. * @type {number} */ var DECIMALS = 4; /** * @const * @type {import("../size.js").Size} */ var GETFEATUREINFO_IMAGE_SIZE = [101, 101]; /** * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer. * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting * the image from the remote server. * @property {import("./wms.js").ServerType} [serverType] The type of * the remote WMS server: `mapserver`, `geoserver`, `carmentaserver`, or `qgis`. * Only needed if `hidpi` is `true`. * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given a URL. * @property {boolean} [imageSmoothing=true] Deprecated. Use the `interpolate` option instead. * @property {boolean} [interpolate=true] Use interpolated values when resampling. By default, * linear interpolation is used when resampling. Set to false to use the nearest neighbor instead. * @property {Object} params WMS request parameters. * At least a `LAYERS` param is required. `STYLES` is * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` * and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically. * @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection. * @property {number} [ratio=1.5] Ratio. `1` means image requests are the size of the map viewport, `2` means * twice the width and height of the map viewport, and so on. Must be `1` or * higher. * @property {Array} [resolutions] Resolutions. * If specified, requests will be made for these resolutions only. * @property {string} url WMS service URL. */ /** * @classdesc * Source for WMS servers providing single, untiled images. * * @fires module:ol/source/Image.ImageSourceEvent * @api */ var ImageWMS = /** @class */ (function (_super) { __extends(ImageWMS, _super); /** * @param {Options} [opt_options] ImageWMS options. */ function ImageWMS(opt_options) { var _this = this; var options = opt_options ? opt_options : {}; var interpolate = options.imageSmoothing !== undefined ? options.imageSmoothing : true; if (options.interpolate !== undefined) { interpolate = options.interpolate; } _this = _super.call(this, { attributions: options.attributions, interpolate: interpolate, projection: options.projection, resolutions: options.resolutions, }) || this; /** * @private * @type {?string} */ _this.crossOrigin_ = options.crossOrigin !== undefined ? options.crossOrigin : null; /** * @private * @type {string|undefined} */ _this.url_ = options.url; /** * @private * @type {import("../Image.js").LoadFunction} */ _this.imageLoadFunction_ = options.imageLoadFunction !== undefined ? options.imageLoadFunction : defaultImageLoadFunction; /** * @private * @type {!Object} */ _this.params_ = options.params || {}; /** * @private * @type {boolean} */ _this.v13_ = true; _this.updateV13_(); /** * @private * @type {import("./wms.js").ServerType} */ _this.serverType_ = options.serverType; /** * @private * @type {boolean} */ _this.hidpi_ = options.hidpi !== undefined ? options.hidpi : true; /** * @private * @type {import("../Image.js").default} */ _this.image_ = null; /** * @private * @type {import("../size.js").Size} */ _this.imageSize_ = [0, 0]; /** * @private * @type {number} */ _this.renderedRevision_ = 0; /** * @private * @type {number} */ _this.ratio_ = options.ratio !== undefined ? options.ratio : 1.5; return _this; } /** * Return the GetFeatureInfo URL for the passed coordinate, resolution, and * projection. Return `undefined` if the GetFeatureInfo URL cannot be * constructed. * @param {import("../coordinate.js").Coordinate} coordinate Coordinate. * @param {number} resolution Resolution. * @param {import("../proj.js").ProjectionLike} projection Projection. * @param {!Object} params GetFeatureInfo params. `INFO_FORMAT` at least should * be provided. If `QUERY_LAYERS` is not provided then the layers specified * in the `LAYERS` parameter will be used. `VERSION` should not be * specified here. * @return {string|undefined} GetFeatureInfo URL. * @api */ ImageWMS.prototype.getFeatureInfoUrl = function (coordinate, resolution, projection, params) { if (this.url_ === undefined) { return undefined; } var projectionObj = getProjection(projection); var sourceProjectionObj = this.getProjection(); if (sourceProjectionObj && sourceProjectionObj !== projectionObj) { resolution = calculateSourceResolution(sourceProjectionObj, projectionObj, coordinate, resolution); coordinate = transform(coordinate, projectionObj, sourceProjectionObj); } var extent = getForViewAndSize(coordinate, resolution, 0, GETFEATUREINFO_IMAGE_SIZE); var baseParams = { 'SERVICE': 'WMS', 'VERSION': DEFAULT_VERSION, 'REQUEST': 'GetFeatureInfo', 'FORMAT': 'image/png', 'TRANSPARENT': true, 'QUERY_LAYERS': this.params_['LAYERS'], }; assign(baseParams, this.params_, params); var x = floor((coordinate[0] - extent[0]) / resolution, DECIMALS); var y = floor((extent[3] - coordinate[1]) / resolution, DECIMALS); baseParams[this.v13_ ? 'I' : 'X'] = x; baseParams[this.v13_ ? 'J' : 'Y'] = y; return this.getRequestUrl_(extent, GETFEATUREINFO_IMAGE_SIZE, 1, sourceProjectionObj || projectionObj, baseParams); }; /** * Return the GetLegendGraphic URL, optionally optimized for the passed * resolution and possibly including any passed specific parameters. Returns * `undefined` if the GetLegendGraphic URL cannot be constructed. * * @param {number} [resolution] Resolution. If set to undefined, `SCALE` * will not be calculated and included in URL. * @param {Object} [params] GetLegendGraphic params. If `LAYER` is set, the * request is generated for this wms layer, else it will try to use the * configured wms layer. Default `FORMAT` is `image/png`. * `VERSION` should not be specified here. * @return {string|undefined} GetLegendGraphic URL. * @api */ ImageWMS.prototype.getLegendUrl = function (resolution, params) { if (this.url_ === undefined) { return undefined; } var baseParams = { 'SERVICE': 'WMS', 'VERSION': DEFAULT_VERSION, 'REQUEST': 'GetLegendGraphic', 'FORMAT': 'image/png', }; if (params === undefined || params['LAYER'] === undefined) { var layers = this.params_.LAYERS; var isSingleLayer = !Array.isArray(layers) || layers.length === 1; if (!isSingleLayer) { return undefined; } baseParams['LAYER'] = layers; } if (resolution !== undefined) { var mpu = this.getProjection() ? this.getProjection().getMetersPerUnit() : 1; var pixelSize = 0.00028; baseParams['SCALE'] = (resolution * mpu) / pixelSize; } assign(baseParams, params); return appendParams(/** @type {string} */ (this.url_), baseParams); }; /** * Get the user-provided params, i.e. those passed to the constructor through * the "params" option, and possibly updated using the updateParams method. * @return {Object} Params. * @api */ ImageWMS.prototype.getParams = function () { return this.params_; }; /** * @param {import("../extent.js").Extent} extent Extent. * @param {number} resolution Resolution. * @param {number} pixelRatio Pixel ratio. * @param {import("../proj/Projection.js").default} projection Projection. * @return {import("../Image.js").default} Single image. */ ImageWMS.prototype.getImageInternal = function (extent, resolution, pixelRatio, projection) { if (this.url_ === undefined) { return null; } resolution = this.findNearestResolution(resolution); if (pixelRatio != 1 && (!this.hidpi_ || this.serverType_ === undefined)) { pixelRatio = 1; } var imageResolution = resolution / pixelRatio; var center = getCenter(extent); var viewWidth = ceil(getWidth(extent) / imageResolution, DECIMALS); var viewHeight = ceil(getHeight(extent) / imageResolution, DECIMALS); var viewExtent = getForViewAndSize(center, imageResolution, 0, [ viewWidth, viewHeight, ]); var requestWidth = ceil((this.ratio_ * getWidth(extent)) / imageResolution, DECIMALS); var requestHeight = ceil((this.ratio_ * getHeight(extent)) / imageResolution, DECIMALS); var requestExtent = getForViewAndSize(center, imageResolution, 0, [ requestWidth, requestHeight, ]); var image = this.image_; if (image && this.renderedRevision_ == this.getRevision() && image.getResolution() == resolution && image.getPixelRatio() == pixelRatio && containsExtent(image.getExtent(), viewExtent)) { return image; } var params = { 'SERVICE': 'WMS', 'VERSION': DEFAULT_VERSION, 'REQUEST': 'GetMap', 'FORMAT': 'image/png', 'TRANSPARENT': true, }; assign(params, this.params_); this.imageSize_[0] = round(getWidth(requestExtent) / imageResolution, DECIMALS); this.imageSize_[1] = round(getHeight(requestExtent) / imageResolution, DECIMALS); var url = this.getRequestUrl_(requestExtent, this.imageSize_, pixelRatio, projection, params); this.image_ = new ImageWrapper(requestExtent, resolution, pixelRatio, url, this.crossOrigin_, this.imageLoadFunction_); this.renderedRevision_ = this.getRevision(); this.image_.addEventListener(EventType.CHANGE, this.handleImageChange.bind(this)); return this.image_; }; /** * Return the image load function of the source. * @return {import("../Image.js").LoadFunction} The image load function. * @api */ ImageWMS.prototype.getImageLoadFunction = function () { return this.imageLoadFunction_; }; /** * @param {import("../extent.js").Extent} extent Extent. * @param {import("../size.js").Size} size Size. * @param {number} pixelRatio Pixel ratio. * @param {import("../proj/Projection.js").default} projection Projection. * @param {Object} params Params. * @return {string} Request URL. * @private */ ImageWMS.prototype.getRequestUrl_ = function (extent, size, pixelRatio, projection, params) { assert(this.url_ !== undefined, 9); // `url` must be configured or set using `#setUrl()` params[this.v13_ ? 'CRS' : 'SRS'] = projection.getCode(); if (!('STYLES' in this.params_)) { params['STYLES'] = ''; } if (pixelRatio != 1) { switch (this.serverType_) { case 'geoserver': var dpi = (90 * pixelRatio + 0.5) | 0; if ('FORMAT_OPTIONS' in params) { params['FORMAT_OPTIONS'] += ';dpi:' + dpi; } else { params['FORMAT_OPTIONS'] = 'dpi:' + dpi; } break; case 'mapserver': params['MAP_RESOLUTION'] = 90 * pixelRatio; break; case 'carmentaserver': case 'qgis': params['DPI'] = 90 * pixelRatio; break; default: // Unknown `serverType` configured assert(false, 8); break; } } params['WIDTH'] = size[0]; params['HEIGHT'] = size[1]; var axisOrientation = projection.getAxisOrientation(); var bbox; if (this.v13_ && axisOrientation.substr(0, 2) == 'ne') { bbox = [extent[1], extent[0], extent[3], extent[2]]; } else { bbox = extent; } params['BBOX'] = bbox.join(','); return appendParams(/** @type {string} */ (this.url_), params); }; /** * Return the URL used for this WMS source. * @return {string|undefined} URL. * @api */ ImageWMS.prototype.getUrl = function () { return this.url_; }; /** * Set the image load function of the source. * @param {import("../Image.js").LoadFunction} imageLoadFunction Image load function. * @api */ ImageWMS.prototype.setImageLoadFunction = function (imageLoadFunction) { this.image_ = null; this.imageLoadFunction_ = imageLoadFunction; this.changed(); }; /** * Set the URL to use for requests. * @param {string|undefined} url URL. * @api */ ImageWMS.prototype.setUrl = function (url) { if (url != this.url_) { this.url_ = url; this.image_ = null; this.changed(); } }; /** * Update the user-provided params. * @param {Object} params Params. * @api */ ImageWMS.prototype.updateParams = function (params) { assign(this.params_, params); this.updateV13_(); this.image_ = null; this.changed(); }; /** * @private */ ImageWMS.prototype.updateV13_ = function () { var version = this.params_['VERSION'] || DEFAULT_VERSION; this.v13_ = compareVersions(version, '1.3') >= 0; }; return ImageWMS; }(ImageSource)); export default ImageWMS; //# sourceMappingURL=ImageWMS.js.map