298 lines
8.6 KiB
JavaScript
298 lines
8.6 KiB
JavaScript
/**
|
|
* @module ol/source/ImageWMS
|
|
*/
|
|
|
|
import {decode} from '../Image.js';
|
|
import {get as getProjection, transform} from '../proj.js';
|
|
import {calculateSourceResolution} from '../reproj.js';
|
|
import ImageSource, {defaultImageLoadFunction} from './Image.js';
|
|
import {createLoader, getFeatureInfoUrl, getLegendUrl} from './wms.js';
|
|
|
|
/**
|
|
* @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} [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<string,*>} [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<number>} [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
|
|
*/
|
|
class ImageWMS extends ImageSource {
|
|
/**
|
|
* @param {Options} [options] ImageWMS options.
|
|
*/
|
|
constructor(options) {
|
|
options = options ? options : {};
|
|
|
|
super({
|
|
attributions: options.attributions,
|
|
interpolate: options.interpolate,
|
|
projection: options.projection,
|
|
resolutions: options.resolutions,
|
|
});
|
|
|
|
/**
|
|
* @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_ = Object.assign({}, options.params);
|
|
|
|
/**
|
|
* @private
|
|
* @type {import("./wms.js").ServerType}
|
|
*/
|
|
this.serverType_ = options.serverType;
|
|
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
this.hidpi_ = options.hidpi !== undefined ? options.hidpi : true;
|
|
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.renderedRevision_ = 0;
|
|
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.ratio_ = options.ratio !== undefined ? options.ratio : 1.5;
|
|
|
|
/**
|
|
* @private
|
|
* @type {import("../proj/Projection.js").default}
|
|
*/
|
|
this.loaderProjection_ = null;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
getFeatureInfoUrl(coordinate, resolution, projection, params) {
|
|
const projectionObj = getProjection(projection);
|
|
const sourceProjectionObj = this.getProjection();
|
|
|
|
if (sourceProjectionObj && sourceProjectionObj !== projectionObj) {
|
|
resolution = calculateSourceResolution(
|
|
sourceProjectionObj,
|
|
projectionObj,
|
|
coordinate,
|
|
resolution,
|
|
);
|
|
coordinate = transform(coordinate, projectionObj, sourceProjectionObj);
|
|
}
|
|
|
|
const options = {
|
|
url: this.url_,
|
|
params: {
|
|
...this.params_,
|
|
...params,
|
|
},
|
|
projection: sourceProjectionObj || projectionObj,
|
|
};
|
|
return getFeatureInfoUrl(options, coordinate, resolution);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
getLegendUrl(resolution, params) {
|
|
return getLegendUrl(
|
|
{
|
|
url: this.url_,
|
|
params: {
|
|
...this.params_,
|
|
...params,
|
|
},
|
|
},
|
|
resolution,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
getParams() {
|
|
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.
|
|
* @override
|
|
*/
|
|
getImageInternal(extent, resolution, pixelRatio, projection) {
|
|
if (this.url_ === undefined) {
|
|
return null;
|
|
}
|
|
if (!this.loader || this.loaderProjection_ !== projection) {
|
|
// Lazily create loader to pick up the view projection and to allow `params` updates
|
|
this.loaderProjection_ = projection;
|
|
this.loader = createLoader({
|
|
crossOrigin: this.crossOrigin_,
|
|
params: this.params_,
|
|
projection: projection,
|
|
serverType: this.serverType_,
|
|
hidpi: this.hidpi_,
|
|
url: this.url_,
|
|
ratio: this.ratio_,
|
|
load: (image, src) => {
|
|
this.image.setImage(image);
|
|
this.imageLoadFunction_(this.image, src);
|
|
return decode(image);
|
|
},
|
|
});
|
|
}
|
|
|
|
return super.getImageInternal(extent, resolution, pixelRatio, projection);
|
|
}
|
|
|
|
/**
|
|
* Return the image load function of the source.
|
|
* @return {import("../Image.js").LoadFunction} The image load function.
|
|
* @api
|
|
*/
|
|
getImageLoadFunction() {
|
|
return this.imageLoadFunction_;
|
|
}
|
|
|
|
/**
|
|
* Return the URL used for this WMS source.
|
|
* @return {string|undefined} URL.
|
|
* @api
|
|
*/
|
|
getUrl() {
|
|
return this.url_;
|
|
}
|
|
|
|
/**
|
|
* Set the image load function of the source.
|
|
* @param {import("../Image.js").LoadFunction} imageLoadFunction Image load function.
|
|
* @api
|
|
*/
|
|
setImageLoadFunction(imageLoadFunction) {
|
|
this.imageLoadFunction_ = imageLoadFunction;
|
|
this.changed();
|
|
}
|
|
|
|
/**
|
|
* Set the URL to use for requests.
|
|
* @param {string|undefined} url URL.
|
|
* @api
|
|
*/
|
|
setUrl(url) {
|
|
if (url != this.url_) {
|
|
this.url_ = url;
|
|
this.loader = null;
|
|
this.changed();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the user-provided params.
|
|
* @param {Object} params Params.
|
|
* @api
|
|
*/
|
|
setParams(params) {
|
|
this.params_ = Object.assign({}, params);
|
|
this.changed();
|
|
}
|
|
|
|
/**
|
|
* Update the user-provided params.
|
|
* @param {Object} params Params.
|
|
* @api
|
|
*/
|
|
updateParams(params) {
|
|
Object.assign(this.params_, params);
|
|
this.changed();
|
|
}
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
changed() {
|
|
this.image = null;
|
|
super.changed();
|
|
}
|
|
}
|
|
|
|
export default ImageWMS;
|