ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Renaming of getGetFeatureInfoUrl and getGetLegendGraphicUrl

Browse Source
This commit is contained in:
Simon Seyock
2019-09-18 10:38:34 +02:00
parent 10326d0e81
commit b2885e86fb
9 changed files with 30 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
changelog/upgrade-notes.md
View File

@@ -254,6 +254,10 @@ The `ol/source/Vector#clear()` method no longer triggers a reload of the data fr
The `ol/source/Vector#refresh()` method now removes all features from the source and triggers a reload of the data from the server. If you were previously using the `refresh()` method to re-render a vector layer, you should instead call `ol/layer/Vector#changed()`. The `ol/source/Vector#refresh()` method now removes all features from the source and triggers a reload of the data from the server. If you were previously using the `refresh()` method to re-render a vector layer, you should instead call `ol/layer/Vector#changed()`.
##### Renaming of `getGetFeatureInfoUrl` to `getFeatureInfoUrl`
The `getGetFeatureInfoUrl` of `ol/source/ImageWMS` and `ol/source/TileWMS` is now called `getFeatureInfoUrl`.
#### Other changes #### Other changes
##### Allow declutter in image render mode ##### Allow declutter in image render mode

2
examples/getfeatureinfo-image.js
View File

@@ -29,7 +29,7 @@ const map = new Map({
map.on('singleclick', function(evt) { map.on('singleclick', function(evt) {
document.getElementById('info').innerHTML = ''; document.getElementById('info').innerHTML = '';
const viewResolution = /** @type {number} */ (view.getResolution()); const viewResolution = /** @type {number} */ (view.getResolution());
const url = wmsSource.getGetFeatureInfoUrl( const url = wmsSource.getFeatureInfoUrl(
evt.coordinate, viewResolution, 'EPSG:3857', evt.coordinate, viewResolution, 'EPSG:3857',
{'INFO_FORMAT': 'text/html'}); {'INFO_FORMAT': 'text/html'});
if (url) { if (url) {

2
examples/getfeatureinfo-tile.js
View File

@@ -29,7 +29,7 @@ const map = new Map({
map.on('singleclick', function(evt) { map.on('singleclick', function(evt) {
document.getElementById('info').innerHTML = ''; document.getElementById('info').innerHTML = '';
const viewResolution = /** @type {number} */ (view.getResolution()); const viewResolution = /** @type {number} */ (view.getResolution());
const url = wmsSource.getGetFeatureInfoUrl( const url = wmsSource.getFeatureInfoUrl(
evt.coordinate, viewResolution, 'EPSG:3857', evt.coordinate, viewResolution, 'EPSG:3857',
{'INFO_FORMAT': 'text/html'}); {'INFO_FORMAT': 'text/html'});
if (url) { if (url) {

4
examples/wms-getlegendgraphic.html
View File

@@ -4,11 +4,11 @@ title: WMS GetLegendGraphic
shortdesc: Example of a WMS GetLegendGraphic. shortdesc: Example of a WMS GetLegendGraphic.
docs: > docs: >
WMS supports the [getLegendGraphic request](https://docs.geoserver.org/latest/en/user/services/wms/get_legend_graphic/index.html). WMS supports the [getLegendGraphic request](https://docs.geoserver.org/latest/en/user/services/wms/get_legend_graphic/index.html).
This example demonstrates the use of the `getGetLegendGraphicUrl` method. This example demonstrates the use of the `getLegendUrl` method.
As a legend can be responsive to the scale it is updated on every change of the resolution. As a legend can be responsive to the scale it is updated on every change of the resolution.
tags: "GetLegendGraphic, getGetLegendGraphicURL, WMS" tags: "GetLegendGraphic, getLegendUrl, WMS"
--- ---
<div id="map" class="map"></div> <div id="map" class="map"></div>
Legend: Legend:

2
examples/wms-getlegendgraphic.js
View File

@@ -12,7 +12,7 @@ const wmsSource = new ImageWMS({
}); });
const updateLegend = function(resolution) { const updateLegend = function(resolution) {
const graphicUrl = wmsSource.getGetLegendGraphicUrl(resolution); const graphicUrl = wmsSource.getLegendUrl(resolution);
const img = document.getElementById('legend'); const img = document.getElementById('legend');
img.src = graphicUrl; img.src = graphicUrl;
}; };

4
src/ol/source/ImageWMS.js
View File

@@ -155,7 +155,7 @@ class ImageWMS extends ImageSource {
* @return {string|undefined} GetFeatureInfo URL. * @return {string|undefined} GetFeatureInfo URL.
* @api * @api
*/ */
getGetFeatureInfoUrl(coordinate, resolution, projection, params) { getFeatureInfoUrl(coordinate, resolution, projection, params) {
if (this.url_ === undefined) { if (this.url_ === undefined) {
return undefined; return undefined;
} }
@@ -202,7 +202,7 @@ class ImageWMS extends ImageSource {
* @return {string|undefined} GetLegendGraphic URL. * @return {string|undefined} GetLegendGraphic URL.
* @api * @api
*/ */
getGetLegendGraphicUrl(resolution, params) { getLegendUrl(resolution, params) {
const layers = this.params_.LAYERS; const layers = this.params_.LAYERS;
const isSingleLayer = !Array.isArray(layers) || this.params_['LAYERS'].length === 1; const isSingleLayer = !Array.isArray(layers) || this.params_['LAYERS'].length === 1;
if (this.url_ === undefined || !isSingleLayer) { if (this.url_ === undefined || !isSingleLayer) {

4
src/ol/source/TileWMS.js
View File

@@ -159,7 +159,7 @@ class TileWMS extends TileImage {
* @return {string|undefined} GetFeatureInfo URL. * @return {string|undefined} GetFeatureInfo URL.
* @api * @api
*/ */
getGetFeatureInfoUrl(coordinate, resolution, projection, params) { getFeatureInfoUrl(coordinate, resolution, projection, params) {
const projectionObj = getProjection(projection); const projectionObj = getProjection(projection);
const sourceProjectionObj = this.getProjection(); const sourceProjectionObj = this.getProjection();
@@ -224,7 +224,7 @@ class TileWMS extends TileImage {
* @return {string|undefined} GetLegendGraphic URL. * @return {string|undefined} GetLegendGraphic URL.
* @api * @api
*/ */
getGetLegendGraphicUrl(resolution, params) { getLegendUrl(resolution, params) {
const layers = this.params_.LAYERS; const layers = this.params_.LAYERS;
const isSingleLayer = !Array.isArray(layers) || this.params_['LAYERS'].length === 1; const isSingleLayer = !Array.isArray(layers) || this.params_['LAYERS'].length === 1;
if (this.urls[0] === undefined || !isSingleLayer) { if (this.urls[0] === undefined || !isSingleLayer) {

18
test/spec/ol/source/imagewms.test.js
View File

@@ -243,11 +243,11 @@ describe('ol.source.ImageWMS', function() {
}); });
describe('#getGetFeatureInfoUrl', function() { describe('#getFeatureInfoUrl', function() {
it('returns the expected GetFeatureInfo URL', function() { it('returns the expected GetFeatureInfo URL', function() {
const source = new ImageWMS(options); const source = new ImageWMS(options);
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[20, 30], resolution, projection, [20, 30], resolution, projection,
{INFO_FORMAT: 'text/plain'}); {INFO_FORMAT: 'text/plain'});
const uri = new URL(url); const uri = new URL(url);
@@ -275,7 +275,7 @@ describe('ol.source.ImageWMS', function() {
it('returns the expected GetFeatureInfo URL when source\'s projection is different from the parameter', function() { it('returns the expected GetFeatureInfo URL when source\'s projection is different from the parameter', function() {
const source = new ImageWMS(optionsReproj); const source = new ImageWMS(optionsReproj);
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[20, 30], resolution, projection, [20, 30], resolution, projection,
{INFO_FORMAT: 'text/plain'}); {INFO_FORMAT: 'text/plain'});
const uri = new URL(url); const uri = new URL(url);
@@ -303,7 +303,7 @@ describe('ol.source.ImageWMS', function() {
it('sets the QUERY_LAYERS param as expected', function() { it('sets the QUERY_LAYERS param as expected', function() {
const source = new ImageWMS(options); const source = new ImageWMS(options);
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[20, 30], resolution, projection, [20, 30], resolution, projection,
{INFO_FORMAT: 'text/plain', QUERY_LAYERS: 'foo,bar'}); {INFO_FORMAT: 'text/plain', QUERY_LAYERS: 'foo,bar'});
const uri = new URL(url); const uri = new URL(url);
@@ -330,11 +330,11 @@ describe('ol.source.ImageWMS', function() {
}); });
}); });
describe('#getGetLegendGraphicUrl', function() { describe('#getLegendUrl', function() {
it('returns the getLegendGraphic url as expected', function() { it('returns the GetLegendGraphic url as expected', function() {
const source = new ImageWMS(options); const source = new ImageWMS(options);
const url = source.getGetLegendGraphicUrl(resolution); const url = source.getLegendUrl(resolution);
const uri = new URL(url); const uri = new URL(url);
expect(uri.protocol).to.be('http:'); expect(uri.protocol).to.be('http:');
expect(uri.hostname).to.be('example.com'); expect(uri.hostname).to.be('example.com');
@@ -350,7 +350,7 @@ describe('ol.source.ImageWMS', function() {
it('does not include SCALE if no resolution was provided', function() { it('does not include SCALE if no resolution was provided', function() {
const source = new ImageWMS(options); const source = new ImageWMS(options);
const url = source.getGetLegendGraphicUrl(); const url = source.getLegendUrl();
const uri = new URL(url); const uri = new URL(url);
const queryData = uri.searchParams; const queryData = uri.searchParams;
expect(queryData.get('SCALE')).to.be(null); expect(queryData.get('SCALE')).to.be(null);
@@ -358,7 +358,7 @@ describe('ol.source.ImageWMS', function() {
it('adds additional params as expected', function() { it('adds additional params as expected', function() {
const source = new ImageWMS(options); const source = new ImageWMS(options);
const url = source.getGetLegendGraphicUrl(resolution, { const url = source.getLegendUrl(resolution, {
STYLE: 'STYLE_VALUE', STYLE: 'STYLE_VALUE',
FEATURETYPE: 'FEATURETYPE_VALUE', FEATURETYPE: 'FEATURETYPE_VALUE',
RULE: 'RULE_VALUE', RULE: 'RULE_VALUE',

16
test/spec/ol/source/tilewms.test.js
View File

@@ -198,12 +198,12 @@ describe('ol.source.TileWMS', function() {
}); });
describe('#getGetFeatureInfoUrl', function() { describe('#getFeatureInfoUrl', function() {
it('returns the expected GetFeatureInfo URL', function() { it('returns the expected GetFeatureInfo URL', function() {
const source = new TileWMS(options); const source = new TileWMS(options);
source.pixelRatio_ = 1; source.pixelRatio_ = 1;
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[-7000000, -12000000], [-7000000, -12000000],
19567.87924100512, getProjection('EPSG:3857'), 19567.87924100512, getProjection('EPSG:3857'),
{INFO_FORMAT: 'text/plain'}); {INFO_FORMAT: 'text/plain'});
@@ -237,7 +237,7 @@ describe('ol.source.TileWMS', function() {
it('returns the expected GetFeatureInfo URL when source\'s projection is different from the parameter', function() { it('returns the expected GetFeatureInfo URL when source\'s projection is different from the parameter', function() {
const source = new TileWMS(optionsReproj); const source = new TileWMS(optionsReproj);
source.pixelRatio_ = 1; source.pixelRatio_ = 1;
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[-7000000, -12000000], [-7000000, -12000000],
19567.87924100512, getProjection('EPSG:3857'), 19567.87924100512, getProjection('EPSG:3857'),
{INFO_FORMAT: 'text/plain'}); {INFO_FORMAT: 'text/plain'});
@@ -267,7 +267,7 @@ describe('ol.source.TileWMS', function() {
it('sets the QUERY_LAYERS param as expected', function() { it('sets the QUERY_LAYERS param as expected', function() {
const source = new TileWMS(options); const source = new TileWMS(options);
source.pixelRatio_ = 1; source.pixelRatio_ = 1;
const url = source.getGetFeatureInfoUrl( const url = source.getFeatureInfoUrl(
[-7000000, -12000000], [-7000000, -12000000],
19567.87924100512, getProjection('EPSG:3857'), 19567.87924100512, getProjection('EPSG:3857'),
{INFO_FORMAT: 'text/plain', QUERY_LAYERS: 'foo,bar'}); {INFO_FORMAT: 'text/plain', QUERY_LAYERS: 'foo,bar'});
@@ -299,11 +299,11 @@ describe('ol.source.TileWMS', function() {
}); });
}); });
describe('#getGetLegendGraphicUrl', function() { describe('#getLegendGraphicUrl', function() {
it('returns the getLegenGraphic url as expected', function() { it('returns the getLegenGraphic url as expected', function() {
const source = new TileWMS(options); const source = new TileWMS(options);
const url = source.getGetLegendGraphicUrl(0.1); const url = source.getLegendUrl(0.1);
const uri = new URL(url); const uri = new URL(url);
expect(uri.protocol).to.be('http:'); expect(uri.protocol).to.be('http:');
expect(uri.hostname).to.be('example.com'); expect(uri.hostname).to.be('example.com');
@@ -319,7 +319,7 @@ describe('ol.source.TileWMS', function() {
it('does not include SCALE if no resolution was provided', function() { it('does not include SCALE if no resolution was provided', function() {
const source = new TileWMS(options); const source = new TileWMS(options);
const url = source.getGetLegendGraphicUrl(); const url = source.getLegendUrl();
const uri = new URL(url); const uri = new URL(url);
const queryData = uri.searchParams; const queryData = uri.searchParams;
expect(queryData.get('SCALE')).to.be(null); expect(queryData.get('SCALE')).to.be(null);
@@ -327,7 +327,7 @@ describe('ol.source.TileWMS', function() {
it('adds additional params as expected', function() { it('adds additional params as expected', function() {
const source = new TileWMS(options); const source = new TileWMS(options);
const url = source.getGetLegendGraphicUrl(0.1, { const url = source.getLegendUrl(0.1, {
STYLE: 'STYLE_VALUE', STYLE: 'STYLE_VALUE',
FEATURETYPE: 'FEATURETYPE_VALUE', FEATURETYPE: 'FEATURETYPE_VALUE',
RULE: 'RULE_VALUE', RULE: 'RULE_VALUE',