From 4a1cda715db97c9a36865d5e804e38458601f39a Mon Sep 17 00:00:00 2001 From: Olivier Guyot Date: Mon, 13 May 2019 16:20:48 +0200 Subject: [PATCH] Layer / update doc to reflect custom render function support --- src/ol/layer/Layer.js | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/ol/layer/Layer.js b/src/ol/layer/Layer.js index 443daf3e6b..775a0cd3d1 100644 --- a/src/ol/layer/Layer.js +++ b/src/ol/layer/Layer.js @@ -53,8 +53,10 @@ import SourceState from '../source/State.js'; /** * @classdesc - * Abstract base class; normally only used for creating subclasses and not - * instantiated in apps. + * Base class from which all layer types are derived. This should only be instantiated + * in the case where a custom layer is be added to the map with a custom `render` function. + * Such a function can be specified in the `options` object, and is expected to return an HTML element. + * * A visual representation of raster or vector map data. * Layers group together those properties that pertain to how the data is to be * displayed, irrespective of the source of that data. @@ -70,6 +72,7 @@ import SourceState from '../source/State.js'; * @fires import("../render/Event.js").RenderEvent#postrender * * @template {import("../source/Source.js").default} SourceType + * @api */ class Layer extends BaseLayer { /**