a116878a57
The addition of full extent tile ranges also allows us to simplify wrapX handling for tile layers. By limiting wrapX to true and false as possible values, we can remove a lot of guessing logic.
432 lines
11 KiB
JavaScript
432 lines
11 KiB
JavaScript
// FIXME add minZoom support
|
|
// FIXME add date line wrap (tile coord transform)
|
|
// FIXME cannot be shared between maps with different projections
|
|
|
|
goog.provide('ol.source.TileWMS');
|
|
|
|
goog.require('goog.array');
|
|
goog.require('goog.asserts');
|
|
goog.require('goog.math');
|
|
goog.require('goog.object');
|
|
goog.require('goog.string');
|
|
goog.require('goog.uri.utils');
|
|
goog.require('ol');
|
|
goog.require('ol.TileCoord');
|
|
goog.require('ol.TileUrlFunction');
|
|
goog.require('ol.extent');
|
|
goog.require('ol.proj');
|
|
goog.require('ol.size');
|
|
goog.require('ol.source.TileImage');
|
|
goog.require('ol.source.wms');
|
|
goog.require('ol.source.wms.ServerType');
|
|
goog.require('ol.tilecoord');
|
|
|
|
|
|
|
|
/**
|
|
* @classdesc
|
|
* Layer source for tile data from WMS servers.
|
|
*
|
|
* @constructor
|
|
* @extends {ol.source.TileImage}
|
|
* @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.
|
|
* @api stable
|
|
*/
|
|
ol.source.TileWMS = function(opt_options) {
|
|
|
|
var options = goog.isDef(opt_options) ? opt_options : {};
|
|
|
|
var params = goog.isDef(options.params) ? options.params : {};
|
|
|
|
var transparent = goog.object.get(params, 'TRANSPARENT', true);
|
|
|
|
goog.base(this, {
|
|
attributions: options.attributions,
|
|
crossOrigin: options.crossOrigin,
|
|
logo: options.logo,
|
|
opaque: !transparent,
|
|
projection: options.projection,
|
|
tileGrid: options.tileGrid,
|
|
tileLoadFunction: options.tileLoadFunction,
|
|
tileUrlFunction: goog.bind(this.tileUrlFunction_, this),
|
|
wrapX: goog.isDef(options.wrapX) ? options.wrapX : true
|
|
});
|
|
|
|
var urls = options.urls;
|
|
if (!goog.isDef(urls) && goog.isDef(options.url)) {
|
|
urls = ol.TileUrlFunction.expandUrl(options.url);
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
* @type {!Array.<string>}
|
|
*/
|
|
this.urls_ = goog.isDefAndNotNull(urls) ? urls : [];
|
|
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.gutter_ = goog.isDef(options.gutter) ? options.gutter : 0;
|
|
|
|
/**
|
|
* @private
|
|
* @type {Object}
|
|
*/
|
|
this.params_ = params;
|
|
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
this.v13_ = true;
|
|
|
|
/**
|
|
* @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 {string}
|
|
*/
|
|
this.coordKeyPrefix_ = '';
|
|
this.resetCoordKeyPrefix_();
|
|
|
|
/**
|
|
* @private
|
|
* @type {ol.Extent}
|
|
*/
|
|
this.tmpExtent_ = ol.extent.createEmpty();
|
|
|
|
this.updateV13_();
|
|
|
|
};
|
|
goog.inherits(ol.source.TileWMS, ol.source.TileImage);
|
|
|
|
|
|
/**
|
|
* 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.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 stable
|
|
*/
|
|
ol.source.TileWMS.prototype.getGetFeatureInfoUrl =
|
|
function(coordinate, resolution, projection, params) {
|
|
|
|
goog.asserts.assert(!('VERSION' in params),
|
|
'key VERSION is not allowed in params');
|
|
|
|
var projectionObj = ol.proj.get(projection);
|
|
|
|
var tileGrid = this.getTileGrid();
|
|
if (goog.isNull(tileGrid)) {
|
|
tileGrid = this.getTileGridForProjection(projectionObj);
|
|
}
|
|
|
|
var tileCoord = tileGrid.getTileCoordForCoordAndResolution(
|
|
coordinate, resolution);
|
|
|
|
if (tileGrid.getResolutions().length <= tileCoord[0]) {
|
|
return undefined;
|
|
}
|
|
|
|
var tileResolution = tileGrid.getResolution(tileCoord[0]);
|
|
var tileExtent = tileGrid.getTileCoordExtent(tileCoord, this.tmpExtent_);
|
|
var tileSize = ol.size.toSize(
|
|
tileGrid.getTileSize(tileCoord[0]), this.tmpSize);
|
|
|
|
var gutter = this.gutter_;
|
|
if (gutter !== 0) {
|
|
tileSize = ol.size.buffer(tileSize, gutter, this.tmpSize);
|
|
tileExtent = ol.extent.buffer(tileExtent,
|
|
tileResolution * gutter, tileExtent);
|
|
}
|
|
|
|
var baseParams = {
|
|
'SERVICE': 'WMS',
|
|
'VERSION': ol.DEFAULT_WMS_VERSION,
|
|
'REQUEST': 'GetFeatureInfo',
|
|
'FORMAT': 'image/png',
|
|
'TRANSPARENT': true,
|
|
'QUERY_LAYERS': this.params_['LAYERS']
|
|
};
|
|
goog.object.extend(baseParams, this.params_, params);
|
|
|
|
var x = Math.floor((coordinate[0] - tileExtent[0]) / tileResolution);
|
|
var y = Math.floor((tileExtent[3] - coordinate[1]) / tileResolution);
|
|
|
|
baseParams[this.v13_ ? 'I' : 'X'] = x;
|
|
baseParams[this.v13_ ? 'J' : 'Y'] = y;
|
|
|
|
return this.getRequestUrl_(tileCoord, tileSize, tileExtent,
|
|
1, projectionObj, baseParams);
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.TileWMS.prototype.getGutter = function() {
|
|
return this.gutter_;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
|
|
return this.coordKeyPrefix_ + goog.base(this, 'getKeyZXY', z, x, y);
|
|
};
|
|
|
|
|
|
/**
|
|
* 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 stable
|
|
*/
|
|
ol.source.TileWMS.prototype.getParams = function() {
|
|
return this.params_;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.TileCoord} tileCoord Tile coordinate.
|
|
* @param {ol.Size} tileSize Tile size.
|
|
* @param {ol.Extent} tileExtent Tile extent.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @param {Object} params Params.
|
|
* @return {string|undefined} Request URL.
|
|
* @private
|
|
*/
|
|
ol.source.TileWMS.prototype.getRequestUrl_ =
|
|
function(tileCoord, tileSize, tileExtent,
|
|
pixelRatio, projection, params) {
|
|
|
|
var urls = this.urls_;
|
|
if (goog.array.isEmpty(urls)) {
|
|
return undefined;
|
|
}
|
|
|
|
params['WIDTH'] = tileSize[0];
|
|
params['HEIGHT'] = tileSize[1];
|
|
|
|
params[this.v13_ ? 'CRS' : 'SRS'] = projection.getCode();
|
|
|
|
if (!('STYLES' in this.params_)) {
|
|
/* jshint -W053 */
|
|
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;
|
|
if (goog.isDef(params['FORMAT_OPTIONS'])) {
|
|
params['FORMAT_OPTIONS'] += ';dpi:' + dpi;
|
|
} else {
|
|
params['FORMAT_OPTIONS'] = 'dpi:' + dpi;
|
|
}
|
|
break;
|
|
case ol.source.wms.ServerType.MAPSERVER:
|
|
params['MAP_RESOLUTION'] = 90 * pixelRatio;
|
|
break;
|
|
case ol.source.wms.ServerType.CARMENTA_SERVER:
|
|
case ol.source.wms.ServerType.QGIS:
|
|
params['DPI'] = 90 * pixelRatio;
|
|
break;
|
|
default:
|
|
goog.asserts.fail('unknown serverType configured');
|
|
break;
|
|
}
|
|
}
|
|
|
|
var axisOrientation = projection.getAxisOrientation();
|
|
var bbox = tileExtent;
|
|
if (this.v13_ && axisOrientation.substr(0, 2) == 'ne') {
|
|
var tmp;
|
|
tmp = tileExtent[0];
|
|
bbox[0] = tileExtent[1];
|
|
bbox[1] = tmp;
|
|
tmp = tileExtent[2];
|
|
bbox[2] = tileExtent[3];
|
|
bbox[3] = tmp;
|
|
}
|
|
params['BBOX'] = bbox.join(',');
|
|
|
|
var url;
|
|
if (urls.length == 1) {
|
|
url = urls[0];
|
|
} else {
|
|
var index = goog.math.modulo(ol.tilecoord.hash(tileCoord), urls.length);
|
|
url = urls[index];
|
|
}
|
|
return goog.uri.utils.appendParamsFromMap(url, params);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {number} z Z.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {ol.Size} Size.
|
|
*/
|
|
ol.source.TileWMS.prototype.getTilePixelSize =
|
|
function(z, pixelRatio, projection) {
|
|
var tileSize = goog.base(this, 'getTilePixelSize', z, pixelRatio, projection);
|
|
if (pixelRatio == 1 || !this.hidpi_ || !goog.isDef(this.serverType_)) {
|
|
return tileSize;
|
|
} else {
|
|
return ol.size.scale(tileSize, pixelRatio, this.tmpSize);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Return the URLs used for this WMS source.
|
|
* @return {!Array.<string>} URLs.
|
|
* @api stable
|
|
*/
|
|
ol.source.TileWMS.prototype.getUrls = function() {
|
|
return this.urls_;
|
|
};
|
|
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
ol.source.TileWMS.prototype.resetCoordKeyPrefix_ = function() {
|
|
var i = 0;
|
|
var res = [];
|
|
|
|
var j, jj;
|
|
for (j = 0, jj = this.urls_.length; j < jj; ++j) {
|
|
res[i++] = this.urls_[j];
|
|
}
|
|
|
|
var key;
|
|
for (key in this.params_) {
|
|
res[i++] = key + '-' + this.params_[key];
|
|
}
|
|
|
|
this.coordKeyPrefix_ = res.join('#');
|
|
};
|
|
|
|
|
|
/**
|
|
* Set the URL to use for requests.
|
|
* @param {string|undefined} url URL.
|
|
* @api stable
|
|
*/
|
|
ol.source.TileWMS.prototype.setUrl = function(url) {
|
|
var urls = goog.isDef(url) ? ol.TileUrlFunction.expandUrl(url) : null;
|
|
this.setUrls(urls);
|
|
};
|
|
|
|
|
|
/**
|
|
* Set the URLs to use for requests.
|
|
* @param {Array.<string>|undefined} urls URLs.
|
|
* @api stable
|
|
*/
|
|
ol.source.TileWMS.prototype.setUrls = function(urls) {
|
|
this.urls_ = goog.isDefAndNotNull(urls) ? urls : [];
|
|
this.resetCoordKeyPrefix_();
|
|
this.changed();
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.TileCoord} tileCoord Tile coordinate.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @param {ol.proj.Projection} projection Projection.
|
|
* @return {string|undefined} Tile URL.
|
|
* @private
|
|
*/
|
|
ol.source.TileWMS.prototype.tileUrlFunction_ =
|
|
function(tileCoord, pixelRatio, projection) {
|
|
|
|
var tileGrid = this.getTileGrid();
|
|
if (goog.isNull(tileGrid)) {
|
|
tileGrid = this.getTileGridForProjection(projection);
|
|
}
|
|
|
|
if (tileGrid.getResolutions().length <= tileCoord[0]) {
|
|
return undefined;
|
|
}
|
|
|
|
if (pixelRatio != 1 && (!this.hidpi_ || !goog.isDef(this.serverType_))) {
|
|
pixelRatio = 1;
|
|
}
|
|
|
|
var tileResolution = tileGrid.getResolution(tileCoord[0]);
|
|
var tileExtent = tileGrid.getTileCoordExtent(tileCoord, this.tmpExtent_);
|
|
var tileSize = ol.size.toSize(
|
|
tileGrid.getTileSize(tileCoord[0]), this.tmpSize);
|
|
|
|
var gutter = this.gutter_;
|
|
if (gutter !== 0) {
|
|
tileSize = ol.size.buffer(tileSize, gutter, this.tmpSize);
|
|
tileExtent = ol.extent.buffer(tileExtent,
|
|
tileResolution * gutter, tileExtent);
|
|
}
|
|
|
|
if (pixelRatio != 1) {
|
|
tileSize = ol.size.scale(tileSize, pixelRatio, this.tmpSize);
|
|
}
|
|
|
|
var baseParams = {
|
|
'SERVICE': 'WMS',
|
|
'VERSION': ol.DEFAULT_WMS_VERSION,
|
|
'REQUEST': 'GetMap',
|
|
'FORMAT': 'image/png',
|
|
'TRANSPARENT': true
|
|
};
|
|
goog.object.extend(baseParams, this.params_);
|
|
|
|
return this.getRequestUrl_(tileCoord, tileSize, tileExtent,
|
|
pixelRatio, projection, baseParams);
|
|
};
|
|
|
|
|
|
/**
|
|
* Update the user-provided params.
|
|
* @param {Object} params Params.
|
|
* @api stable
|
|
*/
|
|
ol.source.TileWMS.prototype.updateParams = function(params) {
|
|
goog.object.extend(this.params_, params);
|
|
this.resetCoordKeyPrefix_();
|
|
this.updateV13_();
|
|
this.changed();
|
|
};
|
|
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
ol.source.TileWMS.prototype.updateV13_ = function() {
|
|
var version =
|
|
goog.object.get(this.params_, 'VERSION', ol.DEFAULT_WMS_VERSION);
|
|
this.v13_ = goog.string.compareVersions(version, '1.3') >= 0;
|
|
};
|