Skip to content

Commit de88737

Browse files
Aymeric DUTREMBLEjailln
Aymeric DUTREMBLE
authored andcommitted
doc(style): specify features supported with labels
1 parent b7538b0 commit de88737

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

src/Core/Style.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,8 @@ function defineStyleProperty(style, category, name, value, defaultValue) {
231231
* then the altitude value is set to 0.
232232
* @property {Object} [point.model] - 3D model to instantiate at each point position.
233233
*
234-
* @property {Object} [text] - All things {@link Label} related.
234+
* @property {Object} [text] - All things {@link Label} related. (Supported for Points features, not yet
235+
* for Lines and Polygons features.)
235236
* @property {String|Function} [text.field] - A string representing a property key of
236237
* a `FeatureGeometry` enclosed in brackets, that will be replaced by the value of the
237238
* property for each geometry. For example, if each geometry contains a `name` property,

src/Layer/LabelLayer.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ class LabelsNode extends THREE.Group {
138138
/**
139139
* A layer to handle a bunch of `Label`. This layer can be created on its own,
140140
* but it is better to use the option `addLabelLayer` on another `Layer` to let
141-
* it work with it (see the `vector_tile_raster_2d` example).
141+
* it work with it (see the `vector_tile_raster_2d` example). Supported for Points features, not yet
142+
* for Lines and Polygons features.
142143
*
143144
* @property {boolean} isLabelLayer - Used to checkout whether this layer is a
144145
* LabelLayer. Default is true. You should not change this, as it is used

0 commit comments

Comments
 (0)