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

Improve documentation of getGetLegendGraphicUrl

Browse Source 
This also adresses one review comment by @jahow on #9762.
This commit is contained in:
Marc Jansen
2019-07-22 14:03:37 +02:00
parent 993bf0d2cb
commit 2869ed245c
2 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -192,11 +192,13 @@ class ImageWMS extends ImageSource {
}
/**
* Return the GetLegendGraphic URL for the passed resolution.
* Return `undefined` if the GetLegendGraphic URL cannot be constructed.
* @param {!number} resolution Resolution. If set to undefined `SCALE`
* will not be calculated.
* @param {!Object} params GetLegendGraphic params. Default `FORMAT` is
* 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. Default `FORMAT` is
* `image/png`. `VERSION` should not be specified here.
* @return {string|undefined} GetLegendGraphic URL.
* @api