diff --git a/examples/plugins_vrt.html b/examples/plugins_vrt.html
index fd2b8ae510..d714985986 100644
--- a/examples/plugins_vrt.html
+++ b/examples/plugins_vrt.html
@@ -71,7 +71,7 @@
haloWidth: 1,
},
}),
- labelEnabled: true,
+ addLabelLayer: true,
});
return view.addLayer(velibLayer);
diff --git a/examples/source_file_gpx_raster.html b/examples/source_file_gpx_raster.html
index 30ff7017d7..3b624cd42c 100644
--- a/examples/source_file_gpx_raster.html
+++ b/examples/source_file_gpx_raster.html
@@ -91,7 +91,7 @@
transparent: true,
source: gpxSource,
style: gpxStyle,
- labelEnabled: true,
+ addLabelLayer: true,
});
return view.addLayer(gpxLayer);
diff --git a/examples/source_file_kml_raster.html b/examples/source_file_kml_raster.html
index 87a381ed21..7ad7b4ac49 100644
--- a/examples/source_file_kml_raster.html
+++ b/examples/source_file_kml_raster.html
@@ -79,7 +79,7 @@
transparent: true,
source: kmlSource,
style: kmlStyle,
- labelEnabled: true,
+ addLabelLayer: true,
});
debug.createTileDebugUI(menuGlobe.gui, view);
diff --git a/examples/source_file_shapefile.html b/examples/source_file_shapefile.html
index 19d6b3fcc5..f03815db00 100644
--- a/examples/source_file_shapefile.html
+++ b/examples/source_file_shapefile.html
@@ -74,7 +74,7 @@
var velibLayer = new itowns.ColorLayer('velib', {
source: velibSource,
style: velibStyle,
- labelEnabled: true,
+ addLabelLayer: true,
});
debug.createTileDebugUI(menuGlobe.gui, view);
diff --git a/examples/vector_tile_dragndrop.html b/examples/vector_tile_dragndrop.html
index 61253cada7..90ac847049 100644
--- a/examples/vector_tile_dragndrop.html
+++ b/examples/vector_tile_dragndrop.html
@@ -50,7 +50,7 @@
var layer = new itowns.ColorLayer(style.name + ' ' + id, {
source,
noTextureParentOutsideLimit: true,
- labelEnabled: true,
+ addLabelLayer: true,
});
view.addLayer(layer).then(() => {
diff --git a/examples/vector_tile_raster_2d.html b/examples/vector_tile_raster_2d.html
index f7e5b21fa0..cce0d04588 100644
--- a/examples/vector_tile_raster_2d.html
+++ b/examples/vector_tile_raster_2d.html
@@ -62,7 +62,7 @@
var mvtLayer = new itowns.ColorLayer('MVT', {
source: mvtSource,
- labelEnabled: true,
+ addLabelLayer: true,
});
view.addLayer(mvtLayer).then(menuGlobe.addLayerGUI.bind(menuGlobe));
diff --git a/examples/vector_tile_raster_3d.html b/examples/vector_tile_raster_3d.html
index f9d0486b73..28aa5eeda9 100644
--- a/examples/vector_tile_raster_3d.html
+++ b/examples/vector_tile_raster_3d.html
@@ -69,7 +69,7 @@
var mvtLayer = new itowns.ColorLayer('MVT', {
source: mvtSource,
fx: 2.5,
- labelEnabled: true,
+ addLabelLayer: true,
});
view.addLayer(mvtLayer);
diff --git a/src/Core/View.js b/src/Core/View.js
index d04692d117..ae810aedba 100644
--- a/src/Core/View.js
+++ b/src/Core/View.js
@@ -74,7 +74,11 @@ function _preprocessLayer(view, layer, parentLayer) {
if (layer.isLabelLayer) {
view.mainLoop.gfxEngine.label2dRenderer.registerLayer(layer);
- } else if (layer.labelEnabled) {
+ } else if (layer.labelEnabled || layer.addLabelLayer) {
+ if (layer.labelEnabled) {
+ // eslint-disable-next-line no-console
+ console.info('layer.labelEnabled is deprecated use addLabelLayer, instead of');
+ }
// Because the features are shared between layer and labelLayer.
layer.buildExtent = true;
const labelLayer = new LabelLayer(`${layer.id}-label`, {
diff --git a/src/Layer/LabelLayer.js b/src/Layer/LabelLayer.js
index 544807b5ea..83f7eac771 100644
--- a/src/Layer/LabelLayer.js
+++ b/src/Layer/LabelLayer.js
@@ -13,7 +13,7 @@ const _extent = new Extent('EPSG:4326', 0, 0, 0, 0);
/**
* A layer to handle a bunch of `Label`. This layer can be created on its own,
- * but it is better to use the option `labelEnabled` on another `Layer` to let
+ * but it is better to use the option `addLabelLayer` on another `Layer` to let
* it work with it (see the `vector_tile_raster_2d` example).
*
* @property {boolean} isLabelLayer - Used to checkout whether this layer is a
diff --git a/src/Layer/Layer.js b/src/Layer/Layer.js
index 2a07469bfd..ac7c677881 100644
--- a/src/Layer/Layer.js
+++ b/src/Layer/Layer.js
@@ -18,9 +18,9 @@ import Cache from 'Core/Scheduler/Cache';
* @property {Promise} whenReady - this promise is resolved when the layer is added and all initializations are done.
* This promise is resolved with this layer.
* This promise is returned by [View#addLayer]{@link View}.
- * @property {boolean} [labelEnabled=false] - Used to tell if this layer has
+ * @property {boolean} [addLabelLayer=false] - Used to tell if this layer has
* labels to display from its data. For example, it needs to be set to `true`
- * for a layer with vector tiles.
+ * for a layer with vector tiles. If it's `true` a new `LabelLayer` is added and attached to this `Layer`.
* @property {object} [zoom] - This property is used only the layer is attached to [TiledGeometryLayer]{@link TiledGeometryLayer}.
* By example,
* The layer checks the tile zoom level to determine if the layer is visible in this tile.
diff --git a/test/unit/view.js b/test/unit/view.js
index 92238c8781..e1bf46ceb6 100644
--- a/test/unit/view.js
+++ b/test/unit/view.js
@@ -26,7 +26,7 @@ describe('Viewer', function () {
crs: 'EPSG:4326',
});
- colorLayer = new ColorLayer('l0', { source, labelEnabled: true, crs: 'EPSG:4326' });
+ colorLayer = new ColorLayer('l0', { source, addLabelLayer: true, crs: 'EPSG:4326' });
colorLayer2 = new ColorLayer('l1', { source });
});