Module type for ol.layer.Layer

src/ol/PluggableMap.js

@@ -63,9 +63,9 @@ import {create as createTransform, apply as applyTransform} from './transform.js
 
 /**
  * @typedef {Object} AtPixelOptions
- * @property {((function(ol.layer.Layer): boolean)|undefined)} layerFilter Layer filter
+ * @property {((function(module:ol/layer/Layer~Layer): boolean)|undefined)} layerFilter Layer filter
  * function. The filter function will receive one argument, the
- * {@link ol.layer.Layer layer-candidate} and it should return a boolean value.
+ * {@link module:ol/layer/Layer~Layer layer-candidate} and it should return a boolean value.
  * Only layers which are visible and for which this function returns `true`
  * will be tested for features. By default, all visible layers will be tested.
  * @property {number} [hitTolerance=0] Hit-detection tolerance in pixels. Pixels

src/ol/control/OverviewMap.js

@@ -45,7 +45,7 @@ const MIN_RATIO = 0.1;
  * @property {boolean} [collapsible=true] Whether the control can be collapsed or not.
  * @property {string|Element} [label='»'] Text label to use for the collapsed
  * overviewmap button. Instead of text, also an element (e.g. a `span` element) can be used.
- * @property {Array.<ol.layer.Layer>|module:ol/Collection~Collection.<ol.layer.Layer>} [layers]
+ * @property {Array.<module:ol/layer/Layer~Layer>|module:ol/Collection~Collection.<module:ol/layer/Layer~Layer>} [layers]
  * Layers for the overview map. If not set, then all main map layers are used
  * instead.
  * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the control
@@ -149,7 +149,7 @@ const OverviewMap = function(opt_options) {
   if (options.layers) {
     options.layers.forEach(
       /**
-       * @param {ol.layer.Layer} layer Layer.
+       * @param {module:ol/layer/Layer~Layer} layer Layer.
        */
       function(layer) {
         ovmap.addLayer(layer);

src/ol/layer/Base.js

@@ -63,7 +63,7 @@ const BaseLayer = function(options) {
    * @private
    */
   this.state_ = /** @type {module:ol/layer/Layer~State} */ ({
-    layer: /** @type {ol.layer.Layer} */ (this),
+    layer: /** @type {module:ol/layer/Layer~Layer} */ (this),
     managed: true
   });
 
@@ -106,9 +106,9 @@ BaseLayer.prototype.getLayerState = function() {
 
 /**
  * @abstract
- * @param {Array.<ol.layer.Layer>=} opt_array Array of layers (to be
+ * @param {Array.<module:ol/layer/Layer~Layer>=} opt_array Array of layers (to be
  *     modified in place).
- * @return {Array.<ol.layer.Layer>} Array of layers.
+ * @return {Array.<module:ol/layer/Layer~Layer>} Array of layers.
  */
 BaseLayer.prototype.getLayersArray = function(opt_array) {};
 

src/ol/layer/Group.js

@@ -149,7 +149,7 @@ LayerGroup.prototype.handleLayersRemove_ = function(collectionEvent) {
 
 
 /**
- * Returns the {@link module:ol/Collection~Collection collection} of {@link ol.layer.Layer layers}
+ * Returns the {@link module:ol/Collection~Collection collection} of {@link module:ol/layer/Layer~Layer layers}
  * in this group.
  * @return {!module:ol/Collection~Collection.<ol.layer.Base>} Collection of
  *   {@link ol.layer.Base layers} that are part of this group.
@@ -162,7 +162,7 @@ LayerGroup.prototype.getLayers = function() {
 
 
 /**
- * Set the {@link module:ol/Collection~Collection collection} of {@link ol.layer.Layer layers}
+ * Set the {@link module:ol/Collection~Collection collection} of {@link module:ol/layer/Layer~Layer layers}
  * in this group.
  * @param {!module:ol/Collection~Collection.<ol.layer.Base>} layers Collection of
  *   {@link ol.layer.Base layers} that are part of this group.

src/ol/layer/Image.js

@@ -14,7 +14,7 @@ import Layer from '../layer/Layer.js';
  * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
- * @extends {ol.layer.Layer}
+ * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
  * @param {olx.layer.ImageOptions=} opt_options Layer options.
  * @api

src/ol/layer/Layer.js

@@ -37,7 +37,7 @@ import SourceState from '../source/State.js';
  * Layers are usually added to a map with {@link ol.Map#addLayer}. Components
  * like {@link module:ol/interaction/Select~Select} use unmanaged layers
  * internally. These unmanaged layers are associated with the map using
- * {@link ol.layer.Layer#setMap} instead.
+ * {@link module:ol/layer/Layer~Layer#setMap} instead.
  *
  * A generic `change` event is fired when the state of the source changes.
  *

src/ol/layer/Tile.js

@@ -16,7 +16,7 @@ import {assign} from '../obj.js';
  * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
- * @extends {ol.layer.Layer}
+ * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
  * @param {olx.layer.TileOptions=} opt_options Tile layer options.
  * @api

src/ol/layer/Vector.js

@@ -26,7 +26,7 @@ const Property = {
  * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
- * @extends {ol.layer.Layer}
+ * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
  * @param {olx.layer.VectorOptions=} opt_options Options.
  * @api

src/ol/renderer/Layer.js

@@ -13,7 +13,7 @@ import SourceState from '../source/State.js';
 /**
  * @constructor
  * @extends {module:ol/Observable~Observable}
- * @param {ol.layer.Layer} layer Layer.
+ * @param {module:ol/layer/Layer~Layer} layer Layer.
  * @struct
  */
 const LayerRenderer = function(layer) {
@@ -22,7 +22,7 @@ const LayerRenderer = function(layer) {
 
   /**
    * @private
-   * @type {ol.layer.Layer}
+   * @type {module:ol/layer/Layer~Layer}
    */
   this.layer_ = layer;
 
@@ -36,7 +36,7 @@ inherits(LayerRenderer, Observable);
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
  * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
  * @param {number} hitTolerance Hit tolerance in pixels.
- * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), ol.layer.Layer): T}
+ * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature), module:ol/layer/Layer~Layer): T}
  *     callback Feature callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
  * @return {T|undefined} Callback result.
@@ -82,7 +82,7 @@ LayerRenderer.prototype.createLoadedTileFinder = function(source, projection, ti
 
 
 /**
- * @return {ol.layer.Layer} Layer.
+ * @return {module:ol/layer/Layer~Layer} Layer.
  */
 LayerRenderer.prototype.getLayer = function() {
   return this.layer_;

src/ol/renderer/Map.js

@@ -91,9 +91,9 @@ function expireIconCache(map, frameState) {
  * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {number} hitTolerance Hit tolerance in pixels.
  * @param {function(this: S, (module:ol/Feature~Feature|ol.render.Feature),
- *     ol.layer.Layer): T} callback Feature callback.
+ *     module:ol/layer/Layer~Layer): T} callback Feature callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
- * @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter
+ * @param {function(this: U, module:ol/layer/Layer~Layer): boolean} layerFilter Layer filter
  *     function, only layers which are visible and for which this function
  *     returns `true` will be tested for features.  By default, all visible
  *     layers will be tested.
@@ -109,7 +109,7 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
 
   /**
    * @param {module:ol/Feature~Feature|ol.render.Feature} feature Feature.
-   * @param {ol.layer.Layer} layer Layer.
+   * @param {module:ol/layer/Layer~Layer} layer Layer.
    * @return {?} Callback result.
    */
   function forEachFeatureAtCoordinate(feature, layer) {
@@ -159,10 +159,10 @@ MapRenderer.prototype.forEachFeatureAtCoordinate = function(coordinate, frameSta
  * @abstract
  * @param {module:ol~Pixel} pixel Pixel.
  * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
- * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
+ * @param {function(this: S, module:ol/layer/Layer~Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
- * @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter
+ * @param {function(this: U, module:ol/layer/Layer~Layer): boolean} layerFilter Layer filter
  *     function, only layers which are visible and for which this function
  *     returns `true` will be tested for features.  By default, all visible
  *     layers will be tested.
@@ -178,7 +178,7 @@ MapRenderer.prototype.forEachLayerAtPixel = function(pixel, frameState, callback
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
  * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
  * @param {number} hitTolerance Hit tolerance in pixels.
- * @param {function(this: U, ol.layer.Layer): boolean} layerFilter Layer filter
+ * @param {function(this: U, module:ol/layer/Layer~Layer): boolean} layerFilter Layer filter
  *     function, only layers which are visible and for which this function
  *     returns `true` will be tested for features.  By default, all visible
  *     layers will be tested.
@@ -195,7 +195,7 @@ MapRenderer.prototype.hasFeatureAtCoordinate = function(coordinate, frameState,
 
 
 /**
- * @param {ol.layer.Layer} layer Layer.
+ * @param {module:ol/layer/Layer~Layer} layer Layer.
  * @protected
  * @return {ol.renderer.Layer} Layer renderer.
  */

src/ol/renderer/canvas/ImageLayer.js

@@ -56,7 +56,7 @@ inherits(CanvasImageLayerRenderer, IntermediateCanvasRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 CanvasImageLayerRenderer['handles'] = function(type, layer) {
@@ -69,7 +69,7 @@ CanvasImageLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.canvas.ImageLayer} The layer renderer.
  */
 CanvasImageLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/canvas/IntermediateCanvas.js

@@ -13,7 +13,7 @@ import {create as createTransform, apply as applyTransform} from '../../transfor
  * @constructor
  * @abstract
  * @extends {ol.renderer.canvas.Layer}
- * @param {ol.layer.Layer} layer Layer.
+ * @param {module:ol/layer/Layer~Layer} layer Layer.
  */
 const IntermediateCanvasRenderer = function(layer) {
 

src/ol/renderer/canvas/Layer.js

@@ -15,7 +15,7 @@ import {create as createTransform, apply as applyTransform, compose as composeTr
  * @constructor
  * @abstract
  * @extends {ol.renderer.Layer}
- * @param {ol.layer.Layer} layer Layer.
+ * @param {module:ol/layer/Layer~Layer} layer Layer.
  */
 const CanvasLayerRenderer = function(layer) {
 
@@ -101,7 +101,7 @@ CanvasLayerRenderer.prototype.dispatchComposeEvent_ = function(type, context, fr
 /**
  * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
  * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
- * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
+ * @param {function(this: S, module:ol/layer/Layer~Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
  * @return {T|undefined} Callback result.

src/ol/renderer/canvas/TileLayer.js

@@ -84,7 +84,7 @@ inherits(CanvasTileLayerRenderer, IntermediateCanvasRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 CanvasTileLayerRenderer['handles'] = function(type, layer) {
@@ -95,7 +95,7 @@ CanvasTileLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.canvas.TileLayer} The layer renderer.
  */
 CanvasTileLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/canvas/VectorLayer.js

@@ -89,7 +89,7 @@ inherits(CanvasVectorLayerRenderer, CanvasLayerRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 CanvasVectorLayerRenderer['handles'] = function(type, layer) {
@@ -100,7 +100,7 @@ CanvasVectorLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.canvas.VectorLayer} The layer renderer.
  */
 CanvasVectorLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/canvas/VectorTileLayer.js

@@ -100,7 +100,7 @@ inherits(CanvasVectorTileLayerRenderer, CanvasTileLayerRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 CanvasVectorTileLayerRenderer['handles'] = function(type, layer) {
@@ -111,7 +111,7 @@ CanvasVectorTileLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.canvas.VectorTileLayer} The layer renderer.
  */
 CanvasVectorTileLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/webgl/ImageLayer.js

@@ -62,7 +62,7 @@ inherits(WebGLImageLayerRenderer, WebGLLayerRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 WebGLImageLayerRenderer['handles'] = function(type, layer) {
@@ -73,7 +73,7 @@ WebGLImageLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.webgl.ImageLayer} The layer renderer.
  */
 WebGLImageLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/webgl/Layer.js

@@ -20,7 +20,7 @@ import {createEmptyTexture} from '../../webgl/Context.js';
  * @abstract
  * @extends {ol.renderer.Layer}
  * @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
- * @param {ol.layer.Layer} layer Layer.
+ * @param {module:ol/layer/Layer~Layer} layer Layer.
  */
 const WebGLLayerRenderer = function(mapRenderer, layer) {
 
@@ -255,7 +255,7 @@ WebGLLayerRenderer.prototype.prepareFrame = function(frameState, layerState, con
  * @abstract
  * @param {module:ol~Pixel} pixel Pixel.
  * @param {module:ol/PluggableMap~FrameState} frameState FrameState.
- * @param {function(this: S, ol.layer.Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
+ * @param {function(this: S, module:ol/layer/Layer~Layer, (Uint8ClampedArray|Uint8Array)): T} callback Layer
  *     callback.
  * @param {S} thisArg Value to use as `this` when executing `callback`.
  * @return {T|undefined} Callback result.

src/ol/renderer/webgl/TileLayer.js

@@ -98,7 +98,7 @@ inherits(WebGLTileLayerRenderer, WebGLLayerRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 WebGLTileLayerRenderer['handles'] = function(type, layer) {
@@ -109,7 +109,7 @@ WebGLTileLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.webgl.TileLayer} The layer renderer.
  */
 WebGLTileLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/renderer/webgl/VectorLayer.js

@@ -73,7 +73,7 @@ inherits(WebGLVectorLayerRenderer, WebGLLayerRenderer);
 /**
  * Determine if this renderer handles the provided layer.
  * @param {ol.renderer.Type} type The renderer type.
- * @param {ol.layer.Layer} layer The candidate layer.
+ * @param {module:ol/layer/Layer~Layer} layer The candidate layer.
  * @return {boolean} The renderer can render the layer.
  */
 WebGLVectorLayerRenderer['handles'] = function(type, layer) {
@@ -84,7 +84,7 @@ WebGLVectorLayerRenderer['handles'] = function(type, layer) {
 /**
  * Create a layer renderer.
  * @param {ol.renderer.Map} mapRenderer The map renderer.
- * @param {ol.layer.Layer} layer The layer to be rendererd.
+ * @param {module:ol/layer/Layer~Layer} layer The layer to be rendererd.
  * @return {ol.renderer.webgl.VectorLayer} The layer renderer.
  */
 WebGLVectorLayerRenderer['create'] = function(mapRenderer, layer) {

src/ol/source/Source.js

@@ -12,7 +12,7 @@ import SourceState from '../source/State.js';
  * @classdesc
  * Abstract base class; normally only used for creating subclasses and not
  * instantiated in apps.
- * Base class for {@link ol.layer.Layer} sources.
+ * Base class for {@link module:ol/layer/Layer~Layer} sources.
  *
  * A generic `change` event is triggered when the state of the source changes.
  *