From 512642f8e2dda97d3446f2bb1fb4b1599f8846ef Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Sun, 29 Nov 2020 00:39:55 +0100 Subject: [PATCH] Document geometry argument of the feature callback for internal use --- src/ol/renderer/vector.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/ol/renderer/vector.js b/src/ol/renderer/vector.js index 8d7d80129e..fcda4e0588 100644 --- a/src/ol/renderer/vector.js +++ b/src/ol/renderer/vector.js @@ -7,6 +7,11 @@ import ImageState from '../ImageState.js'; import {getUid} from '../util.js'; /** + * Feature callback. The callback will be called with three arguments. The first + * argument is one {@link module:ol/Feature feature} or {@link module:ol/render/Feature render feature} + * at the pixel, the second is the {@link module:ol/layer/Layer layer} of the feature and will be null for + * unmanaged layers. The third is the {@link module:ol/geom/SimpleGeometry} of the feature. For features + * with a GeometryCollection geometry, it will be the first detected geometry from the collection. * @template T * @typedef {function(import("../Feature.js").FeatureLike, import("../layer/Layer.js").default, import("../geom/SimpleGeometry.js").default): T} FeatureCallback */