Layer / update doc to reflect custom render function support

This commit is contained in:
Olivier Guyot
2019-05-13 16:20:48 +02:00
parent c9d1725f5c
commit 4a1cda715d
+5 -2
View File
@@ -53,8 +53,10 @@ import SourceState from '../source/State.js';
/** /**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Base class from which all layer types are derived. This should only be instantiated
* instantiated in apps. * 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. * A visual representation of raster or vector map data.
* Layers group together those properties that pertain to how the data is to be * Layers group together those properties that pertain to how the data is to be
* displayed, irrespective of the source of that data. * 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 * @fires import("../render/Event.js").RenderEvent#postrender
* *
* @template {import("../source/Source.js").default} SourceType * @template {import("../source/Source.js").default} SourceType
* @api
*/ */
class Layer extends BaseLayer { class Layer extends BaseLayer {
/** /**