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

Get rid of olx.js and typedef.js typedefs for ol

Browse Source
This commit is contained in:
Andreas Hocevar
2018-03-08 18:42:57 +01:00
parent 8f0ffe2043
commit 95d6251dbb
198 changed files with 2262 additions and 2698 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/ol/source/BingMaps.js
View File

@@ -149,7 +149,7 @@ BingMaps.prototype.handleImageryMetadataResponse = function(response) {
.replace('{culture}', culture);
return (
/**
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @return {string|undefined} Tile URL.

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

@@ -136,7 +136,7 @@ ImageSource.prototype.findNearestResolution = function(resolution) {
/**
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
@@ -180,7 +180,7 @@ ImageSource.prototype.getImage = function(extent, resolution, pixelRatio, projec
/**
* @abstract
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.

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

@@ -57,7 +57,7 @@ const ImageArcGISRest = function(opt_options) {
/**
* @private
* @type {ol.ImageLoadFunctionType}
* @type {module:ol/Image~LoadFunction}
*/
this.imageLoadFunction_ = options.imageLoadFunction !== undefined ?
options.imageLoadFunction : defaultImageLoadFunction;
@@ -77,7 +77,7 @@ const ImageArcGISRest = function(opt_options) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.imageSize_ = [0, 0];
@@ -183,7 +183,7 @@ ImageArcGISRest.prototype.getImageInternal = function(extent, resolution, pixelR
/**
* Return the image load function of the source.
* @return {ol.ImageLoadFunctionType} The image load function.
* @return {module:ol/Image~LoadFunction} The image load function.
* @api
*/
ImageArcGISRest.prototype.getImageLoadFunction = function() {
@@ -192,8 +192,8 @@ ImageArcGISRest.prototype.getImageLoadFunction = function() {
/**
* @param {ol.Extent} extent Extent.
* @param {ol.Size} size Size.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @param {Object} params Params.
@@ -234,7 +234,7 @@ ImageArcGISRest.prototype.getUrl = function() {
/**
* Set the image load function of the source.
* @param {ol.ImageLoadFunctionType} imageLoadFunction Image load function.
* @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
* @api
*/
ImageArcGISRest.prototype.setImageLoadFunction = function(imageLoadFunction) {

14
src/ol/source/ImageMapGuide.js
View File

@@ -55,7 +55,7 @@ const ImageMapGuide = function(options) {
/**
* @private
* @type {ol.ImageLoadFunctionType}
* @type {module:ol/Image~LoadFunction}
*/
this.imageLoadFunction_ = options.imageLoadFunction !== undefined ?
options.imageLoadFunction : defaultImageLoadFunction;
@@ -158,7 +158,7 @@ ImageMapGuide.prototype.getImageInternal = function(extent, resolution, pixelRat
/**
* Return the image load function of the source.
* @return {ol.ImageLoadFunctionType} The image load function.
* @return {module:ol/Image~LoadFunction} The image load function.
* @api
*/
ImageMapGuide.prototype.getImageLoadFunction = function() {
@@ -167,8 +167,8 @@ ImageMapGuide.prototype.getImageLoadFunction = function() {
/**
* @param {ol.Extent} extent The map extents.
* @param {ol.Size} size The viewport size.
* @param {module:ol/extent~Extent} extent The map extents.
* @param {module:ol/size~Size} size The viewport size.
* @param {number} metersPerUnit The meters-per-unit value.
* @param {number} dpi The display resolution.
* @return {number} The computed map scale.
@@ -201,8 +201,8 @@ ImageMapGuide.prototype.updateParams = function(params) {
/**
* @param {string} baseUrl The mapagent url.
* @param {Object.<string, string|number>} params Request parameters.
* @param {ol.Extent} extent Extent.
* @param {ol.Size} size Size.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/size~Size} size Size.
* @param {ol.proj.Projection} projection Projection.
* @return {string} The mapagent map image request URL.
*/
@@ -230,7 +230,7 @@ ImageMapGuide.prototype.getUrl = function(baseUrl, params, extent, size, project
/**
* Set the image load function of the MapGuide source.
* @param {ol.ImageLoadFunctionType} imageLoadFunction Image load function.
* @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
* @api
*/
ImageMapGuide.prototype.setImageLoadFunction = function(imageLoadFunction) {

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

@@ -26,7 +26,7 @@ const Static = function(options) {
const crossOrigin = options.crossOrigin !== undefined ?
options.crossOrigin : null;
const /** @type {ol.ImageLoadFunctionType} */ imageLoadFunction =
const /** @type {module:ol/Image~LoadFunction} */ imageLoadFunction =
options.imageLoadFunction !== undefined ?
options.imageLoadFunction : defaultImageLoadFunction;
@@ -43,7 +43,7 @@ const Static = function(options) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.imageSize_ = options.imageSize ? options.imageSize : null;

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

@@ -52,7 +52,7 @@ const ImageWMS = function(opt_options) {
/**
* @private
* @type {ol.ImageLoadFunctionType}
* @type {module:ol/Image~LoadFunction}
*/
this.imageLoadFunction_ = options.imageLoadFunction !== undefined ?
options.imageLoadFunction : defaultImageLoadFunction;
@@ -90,7 +90,7 @@ const ImageWMS = function(opt_options) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.imageSize_ = [0, 0];
@@ -113,7 +113,7 @@ inherits(ImageWMS, ImageSource);
/**
* @const
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
@@ -122,9 +122,9 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
* 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 {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {ol.ProjectionLike} projection Projection.
* @param {module: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
@@ -245,7 +245,7 @@ ImageWMS.prototype.getImageInternal = function(extent, resolution, pixelRatio, p
/**
* Return the image load function of the source.
* @return {ol.ImageLoadFunctionType} The image load function.
* @return {module:ol/Image~LoadFunction} The image load function.
* @api
*/
ImageWMS.prototype.getImageLoadFunction = function() {
@@ -254,8 +254,8 @@ ImageWMS.prototype.getImageLoadFunction = function() {
/**
* @param {ol.Extent} extent Extent.
* @param {ol.Size} size Size.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/size~Size} size Size.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @param {Object} params Params.
@@ -323,7 +323,7 @@ ImageWMS.prototype.getUrl = function() {
/**
* Set the image load function of the source.
* @param {ol.ImageLoadFunctionType} imageLoadFunction Image load function.
* @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
* @api
*/
ImageWMS.prototype.setImageLoadFunction = function(imageLoadFunction) {

8
src/ol/source/Raster.js
View File

@@ -59,7 +59,7 @@ const RasterSourceEvent = function(type, frameState, data) {
/**
* The raster extent.
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
* @api
*/
this.extent = frameState.extent;
@@ -222,7 +222,7 @@ RasterSource.prototype.setOperation = function(operation, opt_lib) {
/**
* Update the stored frame state.
* @param {ol.Extent} extent The view extent (in map units).
* @param {module:ol/extent~Extent} extent The view extent (in map units).
* @param {number} resolution The view resolution.
* @param {ol.proj.Projection} projection The view projection.
* @return {olx.FrameState} The updated frame state.
@@ -379,7 +379,7 @@ let sharedContext = null;
* Get image data from a renderer.
* @param {ol.renderer.canvas.Layer} renderer Layer renderer.
* @param {olx.FrameState} frameState The frame state.
* @param {ol.LayerState} layerState The layer state.
* @param {module:ol/layer/Layer~State} layerState The layer state.
* @return {ImageData} The image data.
*/
function getImageData(renderer, frameState, layerState) {
@@ -406,7 +406,7 @@ function getImageData(renderer, frameState, layerState) {
/**
* Get a list of layer states from a list of renderers.
* @param {Array.<ol.renderer.canvas.Layer>} renderers Layer renderers.
* @return {Array.<ol.LayerState>} The layer states.
* @return {Array.<module:ol/layer/Layer~State>} The layer states.
*/
function getLayerStatesArray(renderers) {
return renderers.map(function(renderer) {

2
src/ol/source/Source.js
View File

@@ -80,7 +80,7 @@ Source.prototype.adaptAttributions_ = function(attributionLike) {
};
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.

10
src/ol/source/Tile.js
View File

@@ -61,7 +61,7 @@ const TileSource = function(options) {
/**
* @protected
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.tmpSize = [0, 0];
@@ -73,7 +73,7 @@ const TileSource = function(options) {
/**
* @protected
* @type {olx.TileOptions}
* @type {module:ol/Tile~Options}
*/
this.tileOptions = {transition: options.transition};
@@ -254,7 +254,7 @@ TileSource.prototype.getTilePixelRatio = function(pixelRatio) {
* @param {number} z Z.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @return {ol.Size} Tile size.
* @return {module:ol/size~Size} Tile size.
*/
TileSource.prototype.getTilePixelSize = function(z, pixelRatio, projection) {
const tileGrid = this.getTileGridForProjection(projection);
@@ -272,9 +272,9 @@ TileSource.prototype.getTilePixelSize = function(z, pixelRatio, projection) {
* Returns a tile coordinate wrapped around the x-axis. When the tile coordinate
* is outside the resolution and extent range of the tile grid, `null` will be
* returned.
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {ol.proj.Projection=} opt_projection Projection.
* @return {ol.TileCoord} Tile coordinate to be passed to the tileUrlFunction or
* @return {module:ol/tilecoord~TileCoord} Tile coordinate to be passed to the tileUrlFunction or
* null if no tile URL should be created for the passed `tileCoord`.
*/
TileSource.prototype.getTileCoordForTileUrlFunction = function(tileCoord, opt_projection) {

8
src/ol/source/TileArcGISRest.js
View File

@@ -50,7 +50,7 @@ const TileArcGISRest = function(opt_options) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.tmpExtent_ = createEmpty();
@@ -86,9 +86,9 @@ TileArcGISRest.prototype.getParams = function() {
/**
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {ol.Size} tileSize Tile size.
* @param {ol.Extent} tileExtent Tile extent.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {module:ol/extent~Extent} tileExtent Tile extent.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @param {Object} params Params.

6
src/ol/source/TileDebug.js
View File

@@ -13,8 +13,8 @@ import {getKeyZXY} from '../tilecoord.js';
/**
* @constructor
* @extends {ol.Tile}
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {ol.Size} tileSize Tile size.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {string} text Text.
*/
const LabeledTile = function(tileCoord, tileSize, text) {
@@ -23,7 +23,7 @@ const LabeledTile = function(tileCoord, tileSize, text) {
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.tileSize_ = tileSize;

6
src/ol/source/TileImage.js
View File

@@ -53,8 +53,8 @@ const TileImage = function(options) {
/**
* @protected
* @type {function(new: ol.ImageTile, ol.TileCoord, ol.TileState, string,
* ?string, ol.TileLoadFunctionType, olx.TileOptions=)}
* @type {function(new: ol.ImageTile, module:ol/tilecoord~TileCoord, ol.TileState, string,
* ?string, module:ol/Tile~LoadFunction, module:ol/Tile~Options=)}
*/
this.tileClass = options.tileClass !== undefined ?
options.tileClass : ImageTile;
@@ -343,7 +343,7 @@ TileImage.prototype.setRenderReprojectionEdges = function(render) {
* (e.g. projection has no extent defined) or
* for optimization reasons (custom tile size, resolutions, ...).
*
* @param {ol.ProjectionLike} projection Projection.
* @param {module:ol/proj~ProjectionLike} projection Projection.
* @param {ol.tilegrid.TileGrid} tilegrid Tile grid to use for the projection.
* @api
*/

14
src/ol/source/TileUTFGrid.js
View File

@@ -20,10 +20,10 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
/**
* @constructor
* @extends {ol.Tile}
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {ol.TileState} state State.
* @param {string} src Image source URI.
* @param {ol.Extent} extent Extent of the tile.
* @param {module:ol/extent~Extent} extent Extent of the tile.
* @param {boolean} preemptive Load the tile when visible (before it's needed).
* @param {boolean} jsonp Load the tile as a script.
*/
@@ -39,7 +39,7 @@ export const CustomTile = function(tileCoord, state, src, extent, preemptive, js
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.extent_ = extent;
@@ -89,7 +89,7 @@ CustomTile.prototype.getImage = function() {
/**
* Synchronously returns data at given coordinate (if available).
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @return {*} The data.
*/
CustomTile.prototype.getData = function(coordinate) {
@@ -132,7 +132,7 @@ CustomTile.prototype.getData = function(coordinate) {
/**
* Calls the callback (synchronously by default) with the available data
* for given coordinate (or `null` if not yet loaded).
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {function(this: T, *)} callback Callback.
* @param {T=} opt_this The object to use as `this` in the callback.
* @param {boolean=} opt_request If `true` the callback is always async.
@@ -273,7 +273,7 @@ const UTFGrid = function(options) {
/**
* @private
* @type {!ol.TileUrlFunctionType}
* @type {!module:ol/tileurlfunction~Type}
*/
this.tileUrlFunction_ = nullTileUrlFunction;
@@ -355,7 +355,7 @@ UTFGrid.prototype.getTemplate = function() {
* Calls the callback (synchronously by default) with the available data
* for given coordinate and resolution (or `null` if not yet loaded or
* in case of an error).
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {function(*)} callback Callback.
* @param {boolean=} opt_request If `true` the callback is always async.

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

@@ -82,7 +82,7 @@ const TileWMS = function(opt_options) {
/**
* @private
* @type {ol.Extent}
* @type {module:ol/extent~Extent}
*/
this.tmpExtent_ = createEmpty();
@@ -98,9 +98,9 @@ inherits(TileWMS, 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 {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {ol.ProjectionLike} projection Projection.
* @param {module: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
@@ -181,9 +181,9 @@ TileWMS.prototype.getParams = function() {
/**
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {ol.Size} tileSize Tile size.
* @param {ol.Extent} tileExtent Tile extent.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/size~Size} tileSize Tile size.
* @param {module:ol/extent~Extent} tileExtent Tile extent.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @param {Object} params Params.

14
src/ol/source/UrlTile.js
View File

@@ -35,13 +35,13 @@ const UrlTile = function(options) {
/**
* @protected
* @type {ol.TileLoadFunctionType}
* @type {module:ol/Tile~LoadFunction}
*/
this.tileLoadFunction = options.tileLoadFunction;
/**
* @protected
* @type {ol.TileUrlFunctionType}
* @type {module:ol/tileurlfunction~Type}
*/
this.tileUrlFunction = this.fixedTileUrlFunction ?
this.fixedTileUrlFunction.bind(this) : nullTileUrlFunction;
@@ -73,14 +73,14 @@ inherits(UrlTile, TileSource);
/**
* @type {ol.TileUrlFunctionType|undefined}
* @type {module:ol/tileurlfunction~Type|undefined}
* @protected
*/
UrlTile.prototype.fixedTileUrlFunction;
/**
* Return the tile load function of the source.
* @return {ol.TileLoadFunctionType} TileLoadFunction
* @return {module:ol/Tile~LoadFunction} TileLoadFunction
* @api
*/
UrlTile.prototype.getTileLoadFunction = function() {
@@ -90,7 +90,7 @@ UrlTile.prototype.getTileLoadFunction = function() {
/**
* Return the tile URL function of the source.
* @return {ol.TileUrlFunctionType} TileUrlFunction
* @return {module:ol/tileurlfunction~Type} TileUrlFunction
* @api
*/
UrlTile.prototype.getTileUrlFunction = function() {
@@ -137,7 +137,7 @@ UrlTile.prototype.handleTileChange = function(event) {
/**
* Set the tile load function of the source.
* @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @api
*/
UrlTile.prototype.setTileLoadFunction = function(tileLoadFunction) {
@@ -149,7 +149,7 @@ UrlTile.prototype.setTileLoadFunction = function(tileLoadFunction) {
/**
* Set the tile URL function of the source.
* @param {ol.TileUrlFunctionType} tileUrlFunction Tile URL function.
* @param {module:ol/tileurlfunction~Type} tileUrlFunction Tile URL function.
* @param {string=} opt_key Optional new tile key for the source.
* @api
*/

34
src/ol/source/Vector.js
View File

@@ -73,7 +73,7 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {ol.FeatureLoader}
* @type {module:ol/featureloader~FeatureLoader}
*/
this.loader_ = UNDEFINED;
@@ -91,7 +91,7 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {string|ol.FeatureUrlFunction|undefined}
* @type {string|module:ol/featureloader~FeatureUrlFunction|undefined}
*/
this.url_ = options.url;
@@ -120,7 +120,7 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {ol.structs.RBush.<{extent: ol.Extent}>}
* @type {ol.structs.RBush.<{extent: module:ol/extent~Extent}>}
*/
this.loadedExtentsRtree_ = new RBush();
@@ -146,7 +146,7 @@ const VectorSource = function(opt_options) {
/**
* @private
* @type {Object.<string, Array.<ol.EventsKey>>}
* @type {Object.<string, Array.<module:ol/events~EventsKey>>}
*/
this.featureChangeKeys_ = {};
@@ -423,7 +423,7 @@ VectorSource.prototype.forEachFeature = function(callback) {
* a "truthy" value, iteration will stop and the function will return the same
* value.
*
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {function(ol.Feature): T} callback Called with each feature
* whose goemetry contains the provided coordinate.
* @return {T|undefined} The return value from the last call to the callback.
@@ -455,7 +455,7 @@ VectorSource.prototype.forEachFeatureAtCoordinateDirect = function(coordinate, c
* When `useSpatialIndex` is set to false, this method will loop through all
* features, equivalent to {@link ol.source.Vector#forEachFeature}.
*
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {function(ol.Feature): T} callback Called with each feature
* whose bounding box intersects the provided extent.
* @return {T|undefined} The return value from the last call to the callback.
@@ -480,7 +480,7 @@ VectorSource.prototype.forEachFeatureInExtent = function(extent, callback) {
* {@link ol.source.Vector#forEachFeatureInExtent
* source.forEachFeatureInExtent()} method instead.
*
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {function(ol.Feature): T} callback Called with each feature
* whose geometry intersects the provided extent.
* @return {T|undefined} The return value from the last call to the callback.
@@ -539,7 +539,7 @@ VectorSource.prototype.getFeatures = function() {
/**
* Get all features whose geometry intersects the provided coordinate.
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @return {Array.<ol.Feature>} Features.
* @api
*/
@@ -559,7 +559,7 @@ VectorSource.prototype.getFeaturesAtCoordinate = function(coordinate) {
*
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {Array.<ol.Feature>} Features.
* @api
*/
@@ -573,7 +573,7 @@ VectorSource.prototype.getFeaturesInExtent = function(extent) {
*
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @param {ol.Coordinate} coordinate Coordinate.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {function(ol.Feature):boolean=} opt_filter Feature filter function.
* The filter function will receive one argument, the {@link ol.Feature feature}
* and it should return a boolean value. By default, no filtering is made.
@@ -628,9 +628,9 @@ VectorSource.prototype.getClosestFeatureToCoordinate = function(coordinate, opt_
*
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @param {ol.Extent=} opt_extent Destination extent. If provided, no new extent
* @param {module:ol/extent~Extent=} opt_extent Destination extent. If provided, no new extent
* will be created. Instead, that extent's coordinates will be overwritten.
* @return {ol.Extent} Extent.
* @return {module:ol/extent~Extent} Extent.
* @api
*/
VectorSource.prototype.getExtent = function(opt_extent) {
@@ -681,7 +681,7 @@ VectorSource.prototype.getResolutions = function() {};
/**
* Get the url associated with this source.
*
* @return {string|ol.FeatureUrlFunction|undefined} The url.
* @return {string|module:ol/featureloader~FeatureUrlFunction|undefined} The url.
* @api
*/
VectorSource.prototype.getUrl = function() {
@@ -750,7 +750,7 @@ VectorSource.prototype.isEmpty = function() {
/**
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {number} resolution Resolution.
* @param {ol.proj.Projection} projection Projection.
*/
@@ -761,7 +761,7 @@ VectorSource.prototype.loadFeatures = function(extent, resolution, projection) {
const extentToLoad = extentsToLoad[i];
const alreadyLoaded = loadedExtentsRtree.forEachInExtent(extentToLoad,
/**
* @param {{extent: ol.Extent}} object Object.
* @param {{extent: module:ol/extent~Extent}} object Object.
* @return {boolean} Contains.
*/
function(object) {
@@ -777,7 +777,7 @@ VectorSource.prototype.loadFeatures = function(extent, resolution, projection) {
/**
* Remove an extent from the list of loaded extents.
* @param {ol.Extent} extent Extent.
* @param {module:ol/extent~Extent} extent Extent.
* @api
*/
VectorSource.prototype.removeLoadedExtent = function(extent) {
@@ -859,7 +859,7 @@ VectorSource.prototype.removeFromIdIndex_ = function(feature) {
/**
* Set the new loader of the source. The next loadFeatures call will use the
* new loader.
* @param {ol.FeatureLoader} loader The loader to set.
* @param {module:ol/featureloader~FeatureLoader} loader The loader to set.
* @api
*/
VectorSource.prototype.setLoader = function(loader) {

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

@@ -74,8 +74,8 @@ const VectorTileSource = function(options) {
/**
* @protected
* @type {function(new: ol.VectorTile, ol.TileCoord, ol.TileState, string,
* ol.format.Feature, ol.TileLoadFunctionType)}
* @type {function(new: ol.VectorTile, module:ol/tilecoord~TileCoord, ol.TileState, string,
* ol.format.Feature, module:ol/Tile~LoadFunction)}
*/
this.tileClass = options.tileClass ? options.tileClass : VectorTile;

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

@@ -104,7 +104,7 @@ const WMTS = function(options) {
/**
* @param {string} template Template.
* @return {ol.TileUrlFunctionType} Tile URL function.
* @return {module:ol/tileurlfunction~Type} Tile URL function.
* @private
*/
this.createFromWMTSTemplate_ = function(template) {
@@ -121,7 +121,7 @@ const WMTS = function(options) {
return (
/**
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @return {string|undefined} Tile URL.

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

@@ -27,12 +27,12 @@ const TierSizeCalculation = {
* @constructor
* @extends {ol.ImageTile}
* @param {ol.tilegrid.TileGrid} tileGrid TileGrid that the tile belongs to.
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {ol.TileState} state State.
* @param {string} src Image source URI.
* @param {?string} crossOrigin Cross origin.
* @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
* @param {olx.TileOptions=} opt_options Tile options.
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @param {module:ol/Tile~Options=} opt_options Tile options.
*/
export const CustomTile = function(
tileGrid, tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
@@ -47,7 +47,7 @@ export const CustomTile = function(
/**
* @private
* @type {ol.Size}
* @type {module:ol/size~Size}
*/
this.tileSize_ = toSize(tileGrid.getTileSize(tileCoord[0]));
};
@@ -161,13 +161,13 @@ const Zoomify = function(opt_options) {
/**
* @param {string} template Template.
* @return {ol.TileUrlFunctionType} Tile URL function.
* @return {module:ol/tileurlfunction~Type} Tile URL function.
*/
function createFromTemplate(template) {
return (
/**
* @param {ol.TileCoord} tileCoord Tile Coordinate.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile Coordinate.
* @param {number} pixelRatio Pixel ratio.
* @param {ol.proj.Projection} projection Projection.
* @return {string|undefined} Tile URL.