c17ac0cae3
This commit simplifies the exports.js plugin so it only relies on the stability notes to generate the documentation, which completely decouples it from the exportable API. As a rule of thumb, whenever something has an 'api' annotation, it should also have a 'stability' annotation. A more verbose documentation of ol3 specific annotation usage is available in the new 'apidoc/readme.md' file. This commit also modifies all source files to implement these usage suggestions.
367 lines
9.1 KiB
JavaScript
367 lines
9.1 KiB
JavaScript
// FIXME cannot be shared between maps with different projections
|
||
|
||
goog.provide('ol.source.ImageWMS');
|
||
|
||
goog.require('goog.asserts');
|
||
goog.require('goog.object');
|
||
goog.require('goog.string');
|
||
goog.require('goog.uri.utils');
|
||
goog.require('ol.Image');
|
||
goog.require('ol.extent');
|
||
goog.require('ol.proj');
|
||
goog.require('ol.source.Image');
|
||
goog.require('ol.source.wms');
|
||
goog.require('ol.source.wms.ServerType');
|
||
|
||
|
||
|
||
/**
|
||
* @constructor
|
||
* @extends {ol.source.Image}
|
||
* @param {olx.source.ImageWMSOptions=} opt_options Options.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS = function(opt_options) {
|
||
|
||
var options = goog.isDef(opt_options) ? opt_options : {};
|
||
|
||
goog.base(this, {
|
||
attributions: options.attributions,
|
||
extent: options.extent,
|
||
logo: options.logo,
|
||
projection: options.projection,
|
||
resolutions: options.resolutions
|
||
});
|
||
|
||
/**
|
||
* @private
|
||
* @type {?string}
|
||
*/
|
||
this.crossOrigin_ =
|
||
goog.isDef(options.crossOrigin) ? options.crossOrigin : null;
|
||
|
||
/**
|
||
* @private
|
||
* @type {string|undefined}
|
||
*/
|
||
this.url_ = options.url;
|
||
|
||
/**
|
||
* @private
|
||
* @type {Object}
|
||
*/
|
||
this.params_ = options.params;
|
||
|
||
/**
|
||
* @private
|
||
* @type {boolean}
|
||
*/
|
||
this.v13_ = true;
|
||
this.updateV13_();
|
||
|
||
/**
|
||
* @private
|
||
* @type {ol.source.wms.ServerType|undefined}
|
||
*/
|
||
this.serverType_ =
|
||
/** @type {ol.source.wms.ServerType|undefined} */ (options.serverType);
|
||
|
||
/**
|
||
* @private
|
||
* @type {boolean}
|
||
*/
|
||
this.hidpi_ = goog.isDef(options.hidpi) ? options.hidpi : true;
|
||
|
||
/**
|
||
* @private
|
||
* @type {ol.Image}
|
||
*/
|
||
this.image_ = null;
|
||
|
||
/**
|
||
* @private
|
||
* @type {ol.Size}
|
||
*/
|
||
this.imageSize_ = [0, 0];
|
||
|
||
/**
|
||
* @private
|
||
* @type {ol.proj.Projection}
|
||
*/
|
||
this.renderedProjection_ = null;
|
||
|
||
/**
|
||
* @private
|
||
* @type {number}
|
||
*/
|
||
this.renderedResolution_ = NaN;
|
||
|
||
/**
|
||
* @private
|
||
* @type {number}
|
||
*/
|
||
this.renderedRevision_ = 0;
|
||
|
||
/**
|
||
* @private
|
||
* @type {number}
|
||
*/
|
||
this.ratio_ = goog.isDef(options.ratio) ? options.ratio : 1.5;
|
||
|
||
};
|
||
goog.inherits(ol.source.ImageWMS, ol.source.Image);
|
||
|
||
|
||
/**
|
||
* Return the GetFeatureInfo URL for the passed coordinate, resolution, and
|
||
* projection. Return `undefined` if the GetFeatureInfo URL cannot be
|
||
* constructed.
|
||
* @param {ol.Coordinate} coordinate Coordinate.
|
||
* @param {number} resolution Resolution.
|
||
* @param {ol.proj.Projection} 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.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
|
||
function(coordinate, resolution, projection, params) {
|
||
|
||
goog.asserts.assert(!('VERSION' in params));
|
||
|
||
if (!goog.isDef(this.url_) || goog.isNull(this.image_)) {
|
||
return undefined;
|
||
}
|
||
|
||
goog.asserts.assert(this.imageSize_[0] !== 0 &&
|
||
this.imageSize_[1] !== 0);
|
||
goog.asserts.assert(!isNaN(this.renderedResolution_));
|
||
goog.asserts.assert(!goog.isNull(this.renderedProjection_));
|
||
|
||
if (resolution != this.renderedResolution_ ||
|
||
!ol.proj.equivalent(projection, this.renderedProjection_)) {
|
||
return undefined;
|
||
}
|
||
|
||
var extent = this.image_.getExtent();
|
||
var pixelRatio = this.image_.getPixelRatio();
|
||
|
||
var baseParams = {
|
||
'SERVICE': 'WMS',
|
||
'VERSION': ol.source.wms.DEFAULT_VERSION,
|
||
'REQUEST': 'GetFeatureInfo',
|
||
'FORMAT': 'image/png',
|
||
'TRANSPARENT': true,
|
||
'QUERY_LAYERS': goog.object.get(this.params_, 'LAYERS')
|
||
};
|
||
goog.object.extend(baseParams, this.params_, params);
|
||
|
||
var imageResolution = resolution / pixelRatio;
|
||
|
||
var x = Math.floor((coordinate[0] - extent[0]) / imageResolution);
|
||
var y = Math.floor((extent[3] - coordinate[1]) / imageResolution);
|
||
goog.object.set(baseParams, this.v13_ ? 'I' : 'X', x);
|
||
goog.object.set(baseParams, this.v13_ ? 'J' : 'Y', y);
|
||
|
||
return this.getRequestUrl_(extent, this.imageSize_, pixelRatio, projection,
|
||
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.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS.prototype.getParams = function() {
|
||
return this.params_;
|
||
};
|
||
|
||
|
||
/**
|
||
* @inheritDoc
|
||
*/
|
||
ol.source.ImageWMS.prototype.getImage =
|
||
function(extent, resolution, pixelRatio, projection) {
|
||
|
||
if (!goog.isDef(this.url_)) {
|
||
return null;
|
||
}
|
||
|
||
resolution = this.findNearestResolution(resolution);
|
||
|
||
if (pixelRatio != 1 && (!this.hidpi_ || !goog.isDef(this.serverType_))) {
|
||
pixelRatio = 1;
|
||
}
|
||
|
||
var image = this.image_;
|
||
if (!goog.isNull(image) &&
|
||
this.renderedRevision_ == this.getRevision() &&
|
||
image.getResolution() == resolution &&
|
||
image.getPixelRatio() == pixelRatio &&
|
||
ol.extent.containsExtent(image.getExtent(), extent)) {
|
||
return image;
|
||
}
|
||
|
||
var params = {
|
||
'SERVICE': 'WMS',
|
||
'VERSION': ol.source.wms.DEFAULT_VERSION,
|
||
'REQUEST': 'GetMap',
|
||
'FORMAT': 'image/png',
|
||
'TRANSPARENT': true
|
||
};
|
||
goog.object.extend(params, this.params_);
|
||
|
||
extent = extent.slice();
|
||
var centerX = (extent[0] + extent[2]) / 2;
|
||
var centerY = (extent[1] + extent[3]) / 2;
|
||
if (this.ratio_ != 1) {
|
||
var halfWidth = this.ratio_ * ol.extent.getWidth(extent) / 2;
|
||
var halfHeight = this.ratio_ * ol.extent.getHeight(extent) / 2;
|
||
extent[0] = centerX - halfWidth;
|
||
extent[1] = centerY - halfHeight;
|
||
extent[2] = centerX + halfWidth;
|
||
extent[3] = centerY + halfHeight;
|
||
}
|
||
|
||
var imageResolution = resolution / pixelRatio;
|
||
|
||
// Compute an integer width and height.
|
||
var width = Math.ceil(ol.extent.getWidth(extent) / imageResolution);
|
||
var height = Math.ceil(ol.extent.getHeight(extent) / imageResolution);
|
||
|
||
// Modify the extent to match the integer width and height.
|
||
extent[0] = centerX - imageResolution * width / 2;
|
||
extent[2] = centerX + imageResolution * width / 2;
|
||
extent[1] = centerY - imageResolution * height / 2;
|
||
extent[3] = centerY + imageResolution * height / 2;
|
||
|
||
this.imageSize_[0] = width;
|
||
this.imageSize_[1] = height;
|
||
|
||
var url = this.getRequestUrl_(extent, this.imageSize_, pixelRatio,
|
||
projection, params);
|
||
|
||
this.image_ = new ol.Image(extent, resolution, pixelRatio,
|
||
this.getAttributions(), url, this.crossOrigin_);
|
||
|
||
this.renderedProjection_ = projection;
|
||
this.renderedResolution_ = resolution;
|
||
this.renderedRevision_ = this.getRevision();
|
||
|
||
return this.image_;
|
||
|
||
};
|
||
|
||
|
||
/**
|
||
* @param {ol.Extent} extent Extent.
|
||
* @param {ol.Size} size Size.
|
||
* @param {number} pixelRatio Pixel ratio.
|
||
* @param {ol.proj.Projection} projection Projection.
|
||
* @param {Object} params Params.
|
||
* @return {string} Request URL.
|
||
* @private
|
||
*/
|
||
ol.source.ImageWMS.prototype.getRequestUrl_ =
|
||
function(extent, size, pixelRatio, projection, params) {
|
||
|
||
goog.asserts.assert(goog.isDef(this.url_));
|
||
|
||
params[this.v13_ ? 'CRS' : 'SRS'] = projection.getCode();
|
||
|
||
if (!('STYLES' in this.params_)) {
|
||
/* jshint -W053 */
|
||
goog.object.set(params, 'STYLES', new String(''));
|
||
/* jshint +W053 */
|
||
}
|
||
|
||
if (pixelRatio != 1) {
|
||
switch (this.serverType_) {
|
||
case ol.source.wms.ServerType.GEOSERVER:
|
||
var dpi = (90 * pixelRatio + 0.5) | 0;
|
||
goog.object.set(params, 'FORMAT_OPTIONS', 'dpi:' + dpi);
|
||
break;
|
||
case ol.source.wms.ServerType.MAPSERVER:
|
||
goog.object.set(params, 'MAP_RESOLUTION', 90 * pixelRatio);
|
||
break;
|
||
case ol.source.wms.ServerType.CARMENTA_SERVER:
|
||
case ol.source.wms.ServerType.QGIS:
|
||
goog.object.set(params, 'DPI', 90 * pixelRatio);
|
||
break;
|
||
default:
|
||
goog.asserts.fail();
|
||
break;
|
||
}
|
||
}
|
||
|
||
goog.object.set(params, 'WIDTH', size[0]);
|
||
goog.object.set(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;
|
||
}
|
||
goog.object.set(params, 'BBOX', bbox.join(','));
|
||
|
||
return goog.uri.utils.appendParamsFromMap(this.url_, params);
|
||
};
|
||
|
||
|
||
/**
|
||
* Return the URL used for this WMS source.
|
||
* @return {string|undefined} URL.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS.prototype.getUrl = function() {
|
||
return this.url_;
|
||
};
|
||
|
||
|
||
/**
|
||
* @param {string|undefined} url URL.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS.prototype.setUrl = function(url) {
|
||
if (url != this.url_) {
|
||
this.url_ = url;
|
||
this.image_ = null;
|
||
this.dispatchChangeEvent();
|
||
}
|
||
};
|
||
|
||
|
||
/**
|
||
* Update the user-provided params.
|
||
* @param {Object} params Params.
|
||
* @todo stability experimental
|
||
* @todo api
|
||
*/
|
||
ol.source.ImageWMS.prototype.updateParams = function(params) {
|
||
goog.object.extend(this.params_, params);
|
||
this.updateV13_();
|
||
this.image_ = null;
|
||
this.dispatchChangeEvent();
|
||
};
|
||
|
||
|
||
/**
|
||
* @private
|
||
*/
|
||
ol.source.ImageWMS.prototype.updateV13_ = function() {
|
||
var version =
|
||
goog.object.get(this.params_, 'VERSION', ol.source.wms.DEFAULT_VERSION);
|
||
this.v13_ = goog.string.compareVersions(version, '1.3') >= 0;
|
||
};
|