diff --git a/src/ol/map.js b/src/ol/map.js index 1a3a47a991..749e639f38 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -575,15 +575,19 @@ ol.Map.prototype.disposeInternal = function() { * included in the detection. * @param {ol.Pixel} pixel Pixel. * @param {function(this: S, ol.Feature, ol.layer.Layer): T} callback Feature - * callback. If the detected feature is not on a layer, but on a - * {@link ol.FeatureOverlay}, then the 2nd argument to this function will - * be `null`. To stop detection, callback functions can return a truthy - * value. + * callback. The callback will be called with two arguments. The first + * argument is one {@link ol.Feature feature} at the pixel, the second is + * the {@link ol.layer.Layer layer} of the feature. If the detected feature + * is not on a layer, but on a {@link ol.FeatureOverlay}, then the second + * argument to this function will be `null`. To stop detection, callback + * functions can return a truthy value. * @param {S=} opt_this Value to use as `this` when executing `callback`. * @param {(function(this: U, ol.layer.Layer): boolean)=} opt_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. Feature overlays will always be tested. + * filter function. The filter function will receive one argument, the + * {@link ol.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. Feature overlays will always be tested. * @param {U=} opt_this2 Value to use as `this` when executing `layerFilter`. * @return {T|undefined} Callback result, i.e. the return value of last * callback execution, or the first truthy callback return value. @@ -613,15 +617,18 @@ ol.Map.prototype.forEachFeatureAtPixel = * always be included in the detection. * @param {ol.Pixel} pixel Pixel. * @param {function(this: S, ol.layer.Layer): T} callback Layer - * callback. If the detected feature is not on a layer, but on a - * {@link ol.FeatureOverlay}, then the argument to this function will - * be `null`. To stop detection, callback functions can return a truthy - * value. + * callback. Will receive one arguemnt, the {@link ol.layer.Layer layer} + * that contains the color pixel. If the detected color value is not from a + * layer, but from a {@link ol.FeatureOverlay}, then the argument to this + * function will be `null`. To stop detection, callback functions can return + * a truthy value. * @param {S=} opt_this Value to use as `this` when executing `callback`. * @param {(function(this: U, ol.layer.Layer): boolean)=} opt_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. Feature overlays will always be tested. + * filter function. The filter function will receive one argument, the + * {@link ol.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. Feature overlays will always be tested. * @param {U=} opt_this2 Value to use as `this` when executing `layerFilter`. * @return {T|undefined} Callback result, i.e. the return value of last * callback execution, or the first truthy callback return value. @@ -649,9 +656,11 @@ ol.Map.prototype.forEachLayerAtPixel = * always be included in the detection. * @param {ol.Pixel} pixel Pixel. * @param {(function(this: U, ol.layer.Layer): boolean)=} opt_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. Feature overlays will always be tested. + * filter function. The filter function will receive one argument, the + * {@link ol.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. Feature overlays will always be tested. * @param {U=} opt_this Value to use as `this` when executing `layerFilter`. * @return {boolean} Is there a feature at the given pixel? * @template U