Module type for ol.source.*

This commit is contained in:
Frederic Junod
2018-04-25 13:54:44 +02:00
parent 76769f9901
commit d8e0212833
4 changed files with 11 additions and 11 deletions

View File

@@ -46,7 +46,7 @@ import {appendParams} from '../uri.js';
* *
* If underlying map service is not using labels, * If underlying map service is not using labels,
* take advantage of ol image caching and use * take advantage of ol image caching and use
* {@link ol.source.TileArcGISRest} data source. * {@link module:ol/source/TileArcGISRest} data source.
* *
* @constructor * @constructor
* @fires ol.source.Image.Event * @fires ol.source.Image.Event

View File

@@ -26,7 +26,7 @@ import {appendParams} from '../uri.js';
* {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail. * {@link 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 * @property {boolean} [hidpi=true] Use the `ol.Map#pixelRatio` value when requesting
* the image from the remote server. * the image from the remote server.
* @property {ol.source.WMSServerType|string} [serverType] The type of * @property {module:ol/source/WMSServerType|string} [serverType] The type of
* the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`. * the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only needed if `hidpi` is `true`.
* @property {ol.ImageLoadFunctionType} [imageLoadFunction] Optional function to load an image given a URL. * @property {ol.ImageLoadFunctionType} [imageLoadFunction] Optional function to load an image given a URL.
* @property {Object.<string,*>} params WMS request parameters. * @property {Object.<string,*>} params WMS request parameters.
@@ -98,9 +98,9 @@ const ImageWMS = function(opt_options) {
/** /**
* @private * @private
* @type {ol.source.WMSServerType|undefined} * @type {module:ol/source/WMSServerType|undefined}
*/ */
this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType); this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType);
/** /**
* @private * @private

View File

@@ -50,7 +50,7 @@ import {appendParams} from '../uri.js';
* If this is not defined, a default grid will be used: if there is a projection * If this is not defined, a default grid will be used: if there is a projection
* extent, the grid will be based on that; if not, a grid based on a global * extent, the grid will be based on that; if not, a grid based on a global
* extent with origin at 0,0 will be used.. * extent with origin at 0,0 will be used..
* @property {ol.source.WMSServerType|string} [serverType] * @property {module:ol/source/WMSServerType|string} [serverType]
* The type of the remote WMS server. Currently only used when `hidpi` is * The type of the remote WMS server. Currently only used when `hidpi` is
* `true`. * `true`.
* @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is * @property {module:ol/Tile~LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is
@@ -124,9 +124,9 @@ const TileWMS = function(opt_options) {
/** /**
* @private * @private
* @type {ol.source.WMSServerType|undefined} * @type {module:ol/source/WMSServerType|undefined}
*/ */
this.serverType_ = /** @type {ol.source.WMSServerType|undefined} */ (options.serverType); this.serverType_ = /** @type {module:ol/source/WMSServerType|undefined} */ (options.serverType);
/** /**
* @private * @private

View File

@@ -24,7 +24,7 @@ import {appendParams} from '../uri.js';
* @property {module:ol/proj~ProjectionLike} projection Projection. * @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * Higher values can increase reprojection performance, but decrease precision.
* @property {ol.source.WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding. * @property {module:ol/source/WMTSRequestEncoding|string} [requestEncoding='KVP'] Request encoding.
* @property {string} layer Layer name as advertised in the WMTS capabilities. * @property {string} layer Layer name as advertised in the WMTS capabilities.
* @property {string} style Style name as advertised in the WMTS capabilities. * @property {string} style Style name as advertised in the WMTS capabilities.
* @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. Default is {@link module:ol/ImageTile~ImageTile}. * @property {module:ol/ImageTile~TileClass} [tileClass] Class used to instantiate image tiles. Default is {@link module:ol/ImageTile~ImageTile}.
@@ -115,10 +115,10 @@ const WMTS = function(options) {
/** /**
* @private * @private
* @type {ol.source.WMTSRequestEncoding} * @type {module:ol/source/WMTSRequestEncoding}
*/ */
this.requestEncoding_ = options.requestEncoding !== undefined ? this.requestEncoding_ = options.requestEncoding !== undefined ?
/** @type {ol.source.WMTSRequestEncoding} */ (options.requestEncoding) : /** @type {module:ol/source/WMTSRequestEncoding} */ (options.requestEncoding) :
WMTSRequestEncoding.KVP; WMTSRequestEncoding.KVP;
const requestEncoding = this.requestEncoding_; const requestEncoding = this.requestEncoding_;
@@ -276,7 +276,7 @@ WMTS.prototype.getMatrixSet = function() {
/** /**
* Return the request encoding, either "KVP" or "REST". * Return the request encoding, either "KVP" or "REST".
* @return {ol.source.WMTSRequestEncoding} Request encoding. * @return {module:ol/source/WMTSRequestEncoding} Request encoding.
* @api * @api
*/ */
WMTS.prototype.getRequestEncoding = function() { WMTS.prototype.getRequestEncoding = function() {