Module type for ol.layer.Layer

This commit is contained in:
Frederic Junod
2018-03-22 12:00:19 +01:00
parent 041b612fd9
commit bd9e603036
21 changed files with 44 additions and 44 deletions
+4 -4
View File
@@ -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_;
+7 -7
View File
@@ -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.
*/
+2 -2
View File
@@ -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) {
+1 -1
View File
@@ -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) {
+2 -2
View File
@@ -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.
+2 -2
View File
@@ -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) {
+2 -2
View File
@@ -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) {
+2 -2
View File
@@ -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) {
+2 -2
View File
@@ -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) {
+2 -2
View File
@@ -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.
+2 -2
View File
@@ -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) {
+2 -2
View File
@@ -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) {