Merge pull request openlayers#8025 from romanzoller/remove-ol-layer-olx

Move olx.layer.* to ol/layer/*

src/ol/layer/Group.js

@@ -15,6 +15,22 @@ import {assign, clear} from '../obj.js';
 import SourceState from '../source/State.js';
 
 
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {(Array.<ol.layer.Base>|ol.Collection.<ol.layer.Base>)} [layers] Child layers.
+ */
+
+
 /**
  * @enum {string}
  * @private
@@ -32,13 +48,13 @@ const Property = {
  *
  * @constructor
  * @extends {module:ol/layer/Base~BaseLayer}
- * @param {olx.layer.GroupOptions=} opt_options Layer options.
+ * @param {module:ol/layer/Group~Options=} opt_options Layer options.
  * @api
  */
 const LayerGroup = function(opt_options) {
 
   const options = opt_options || {};
-  const baseOptions = /** @type {olx.layer.GroupOptions} */ (assign({}, options));
+  const baseOptions = /** @type {module:ol/layer/Group~Options} */ (assign({}, options));
   delete baseOptions.layers;
 
   let layers = options.layers;

src/ol/layer/Heatmap.js

@@ -13,6 +13,30 @@ import Icon from '../style/Icon.js';
 import Style from '../style/Style.js';
 
 
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {Array.<string>} [gradient=['#00f', '#0ff', '#0f0', '#ff0', '#f00']] The color gradient
+ * of the heatmap, specified as an array of CSS color strings.
+ * @property {number} [radius=8] Radius size in pixels.
+ * @property {number} [blur=15] Blur size in pixels.
+ * @property {number} [shadow=250] Shadow size in pixels.
+ * @property {string|function(module:ol/Feature~Feature):number} [weight='weight'] The feature
+ * attribute to use for the weight or a function that returns a weight from a feature. Weight values
+ * should range from 0 to 1 (and values outside will be clamped to that range).
+ * @property {ol.source.Vector} [source] Source.
+ */
+
+
 /**
  * @enum {string}
  * @private
@@ -41,7 +65,7 @@ const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00'];
  * @constructor
  * @extends {module:ol/layer/Vector~VectorLayer}
  * @fires ol.render.Event
- * @param {olx.layer.HeatmapOptions=} opt_options Options.
+ * @param {module:ol/layer/Heatmap~Options=} opt_options Options.
  * @api
  */
 const Heatmap = function(opt_options) {
@@ -54,7 +78,7 @@ const Heatmap = function(opt_options) {
   delete baseOptions.blur;
   delete baseOptions.shadow;
   delete baseOptions.weight;
-  VectorLayer.call(this, /** @type {olx.layer.VectorOptions} */ (baseOptions));
+  VectorLayer.call(this, /** @type {module:ol/layer/Vector~Options} */ (baseOptions));
 
   /**
    * @private

src/ol/layer/Image.js

@@ -5,6 +5,27 @@ import {inherits} from '../index.js';
 import LayerType from '../LayerType.js';
 import Layer from '../layer/Layer.js';
 
+
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {ol.PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage
+ * this layer in its layers collection, and the layer will be rendered on top. This is useful for
+ * temporary layers. The standard way to add a layer to a map and have it managed by the map is to
+ * use {@link ol.Map#addLayer}.
+ * @property {ol.source.Image} [source] Source for this layer.
+ */
+
+
 /**
  * @classdesc
  * Server-rendered images that are available for arbitrary extents and
@@ -16,12 +37,12 @@ import Layer from '../layer/Layer.js';
  * @constructor
  * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
- * @param {olx.layer.ImageOptions=} opt_options Layer options.
+ * @param {module:ol/layer/Image~Options=} opt_options Layer options.
  * @api
  */
 const ImageLayer = function(opt_options) {
   const options = opt_options ? opt_options : {};
-  Layer.call(this,  /** @type {olx.layer.LayerOptions} */ (options));
+  Layer.call(this,  /** @type {module:ol/layer/Layer~Options} */ (options));
 
   /**
    * The layer type.

src/ol/layer/Layer.js

@@ -12,6 +12,24 @@ import RenderEventType from '../render/EventType.js';
 import SourceState from '../source/State.js';
 
 
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {ol.source.Source} [source] Source for this layer.  If not provided to the constructor,
+ * the source can be set by calling {@link ol.layer.Layer#setSource layer.setSource(source)} after
+ * construction.
+ */
+
+
 /**
  * @typedef {Object} State
  * @property {module:ol/layer/Layer~Layer} layer
@@ -45,7 +63,7 @@ import SourceState from '../source/State.js';
  * @abstract
  * @extends {module:ol/layer/Base~BaseLayer}
  * @fires ol.render.Event
- * @param {olx.layer.LayerOptions} options Layer options.
+ * @param {module:ol/layer/Layer~Options} options Layer options.
  * @api
  */
 const Layer = function(options) {

src/ol/layer/Tile.js

@@ -7,6 +7,30 @@ import Layer from '../layer/Layer.js';
 import TileProperty from '../layer/TileProperty.js';
 import {assign} from '../obj.js';
 
+
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {number} [preload=0] Preload. Load low-resolution tiles up to `preload` levels. `0`
+ * means no preloading.
+ * @property {ol.source.Tile} [source] Source for this layer.
+ * @property {ol.PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage
+ * this layer in its layers collection, and the layer will be rendered on top. This is useful for
+ * temporary layers. The standard way to add a layer to a map and have it managed by the map is to
+ * use {@link ol.Map#addLayer}.
+ * @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
+ */
+
+
 /**
  * @classdesc
  * For layer sources that provide pre-rendered, tiled images in grids that are
@@ -18,7 +42,7 @@ import {assign} from '../obj.js';
  * @constructor
  * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
- * @param {olx.layer.TileOptions=} opt_options Tile layer options.
+ * @param {module:ol/layer/Tile~Options=} opt_options Tile layer options.
  * @api
  */
 const TileLayer = function(opt_options) {
@@ -28,7 +52,7 @@ const TileLayer = function(opt_options) {
 
   delete baseOptions.preload;
   delete baseOptions.useInterimTilesOnError;
-  Layer.call(this,  /** @type {olx.layer.LayerOptions} */ (baseOptions));
+  Layer.call(this,  /** @type {module:ol/layer/Layer~Options} */ (baseOptions));
 
   this.setPreload(options.preload !== undefined ? options.preload : 0);
   this.setUseInterimTilesOnError(options.useInterimTilesOnError !== undefined ?

src/ol/layer/Vector.js

@@ -9,6 +9,49 @@ import {assign} from '../obj.js';
 import {createDefaultStyle, toFunction as toStyleFunction} from '../style/Style.js';
 
 
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {ol.RenderOrderFunction} [renderOrder] Render order. Function to be used when sorting
+ * features before rendering. By default features are drawn in the order that they are created. Use
+ * `null` to avoid the sort, but get an undefined draw order.
+ * @property {number} [renderBuffer=100] The buffer in pixels around the viewport extent used by the
+ * renderer when getting features from the vector source for the rendering or hit-detection.
+ * Recommended value: the size of the largest symbol, line width or label.
+ * @property {ol.layer.VectorRenderType|string} [renderMode='vector'] Render mode for vector layers:
+ *  * `'image'`: Vector layers are rendered as images. Great performance, but point symbols and
+ *    texts are always rotated with the view and pixels are scaled during zoom animations.
+ *  * `'vector'`: Vector layers are rendered as vectors. Most accurate rendering even during
+ *    animations, but slower performance.
+ * @property {ol.source.Vector} [source] Source.
+ * @property {ol.PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage
+ * this layer in its layers collection, and the layer will be rendered on top. This is useful for
+ * temporary layers. The standard way to add a layer to a map and have it managed by the map is to
+ * use {@link ol.Map#addLayer}.
+ * @property {boolean} [declutter=false] Declutter images and text. Decluttering is applied to all
+ * image and text styles, and the priority is defined by the z-index of the style. Lower z-index
+ * means higher priority.
+ * @property {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction} [style] Layer style. See
+ * {@link ol.style} for default style which will be used if this is not defined.
+ * @property {number} [maxTilesLoading=16] Maximum number tiles to load simultaneously.
+ * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be
+ * recreated during animations. This means that no vectors will be shown clipped, but the setting
+ * will have a performance impact for large amounts of vector data. When set to `false`, batches
+ * will be recreated when no animation is active.
+ * @property {boolean} [updateWhileInteracting=false] When set to `true`, feature batches will be
+ * recreated during interactions. See also `updateWhileAnimating`.
+ */
+
+
 /**
  * @enum {string}
  * @private
@@ -28,20 +71,20 @@ const Property = {
  * @constructor
  * @extends {module:ol/layer/Layer~Layer}
  * @fires ol.render.Event
- * @param {olx.layer.VectorOptions=} opt_options Options.
+ * @param {module:ol/layer/Vector~Options=} opt_options Options.
  * @api
  */
 const VectorLayer = function(opt_options) {
   const options = opt_options ?
-    opt_options : /** @type {olx.layer.VectorOptions} */ ({});
+    opt_options : /** @type {module:ol/layer/Vector~Options} */ ({});
 
   const baseOptions = assign({}, options);
 
   delete baseOptions.style;
   delete baseOptions.renderBuffer;
   delete baseOptions.updateWhileAnimating;
   delete baseOptions.updateWhileInteracting;
-  Layer.call(this, /** @type {olx.layer.LayerOptions} */ (baseOptions));
+  Layer.call(this, /** @type {module:ol/layer/Layer~Options} */ (baseOptions));
 
   /**
    * @private

src/ol/layer/VectorTile.js

@@ -9,6 +9,65 @@ import VectorLayer from '../layer/Vector.js';
 import VectorTileRenderType from '../layer/VectorTileRenderType.js';
 import {assign} from '../obj.js';
 
+
+/**
+ * @typedef {Object} Options
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {ol.Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex=0] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {ol.RenderOrderFunction} [renderOrder] Render order. Function to be used when sorting
+ * features before rendering. By default features are drawn in the order that they are created. Use
+ * `null` to avoid the sort, but get an undefined draw order.
+ * @property {number} [renderBuffer=100] The buffer in pixels around the tile extent used by the
+ * renderer when getting features from the vector tile for the rendering or hit-detection.
+ * Recommended value: Vector tiles are usually generated with a buffer, so this value should match
+ * the largest possible buffer of the used tiles. It should be at least the size of the largest
+ * point symbol or line width.
+ * @property {ol.layer.VectorRenderType|string} [renderMode='hybrid'] Render mode for vector tiles:
+ *  * `'image'`: Vector tiles are rendered as images. Great performance, but point symbols and texts
+ *    are always rotated with the view and pixels are scaled during zoom animations.
+ *  * `'hybrid'`: Polygon and line elements are rendered as images, so pixels are scaled during zoom
+ *    animations. Point symbols and texts are accurately rendered as vectors and can stay upright on
+ *    rotated views.
+ *  * `'vector'`: Vector tiles are rendered as vectors. Most accurate rendering even during
+ *    animations, but slower performance than the other options.
+ *
+ * When `declutter` is set to `true`, `'hybrid'` will be used instead of `'image'`.
+ * @property {ol.source.VectorTile} [source] Source.
+ * @property {ol.PluggableMap} [map] Sets the layer as overlay on a map. The map will not manage
+ * this layer in its layers collection, and the layer will be rendered on top. This is useful for
+ * temporary layers. The standard way to add a layer to a map and have it managed by the map is to
+ * use {@link ol.Map#addLayer}.
+ * @property {boolean} [declutter=false] Declutter images and text. Decluttering is applied to all
+ * image and text styles, and the priority is defined by the z-index of the style. Lower z-index
+ * means higher priority. When set to `true`, a `renderMode` of `'image'` will be overridden with
+ * `'hybrid'`.
+ * @property {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction} [style] Layer style. See
+ * {@link ol.style} for default style which will be used if this is not defined.
+ * @property {number} [maxTilesLoading=16] Maximum number tiles to load simultaneously.
+ * @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be
+ * recreated during animations. This means that no vectors will be shown clipped, but the setting
+ * will have a performance impact for large amounts of vector data. When set to `false`, batches
+ * will be recreated when no animation is active.
+ * @property {boolean} [updateWhileInteracting=false] When set to `true`, feature batches will be
+ * recreated during interactions. See also `updateWhileAnimating`.
+ * @property {number} [preload=0] Preload. Load low-resolution tiles up to `preload` levels. `0`
+ * means no preloading.
+ * @property {ol.RenderOrderFunction} [renderOrder] Render order. Function to be used when sorting
+ * features before rendering. By default features are drawn in the order that they are created.
+ * @property {(ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction)} [style] Layer style. See
+ * {@link ol.style} for default style which will be used if this is not defined.
+ * @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
+ */
+
+
 /**
  * @classdesc
  * Layer for vector tile data that is rendered client-side.
@@ -18,7 +77,7 @@ import {assign} from '../obj.js';
  *
  * @constructor
  * @extends {module:ol/layer/Vector~VectorLayer}
- * @param {olx.layer.VectorTileOptions=} opt_options Options.
+ * @param {module:ol/layer/VectorTile~Options=} opt_options Options.
  * @api
  */
 const VectorTileLayer = function(opt_options) {
@@ -39,10 +98,10 @@ const VectorTileLayer = function(opt_options) {
 
   delete baseOptions.preload;
   delete baseOptions.useInterimTilesOnError;
-  VectorLayer.call(this,  /** @type {olx.layer.VectorOptions} */ (baseOptions));
+  VectorLayer.call(this,  /** @type {module:ol/layer/Vector~Options} */ (baseOptions));
 
   this.setPreload(options.preload ? options.preload : 0);
-  this.setUseInterimTilesOnError(options.useInterimTilesOnError ?
+  this.setUseInterimTilesOnError(options.useInterimTilesOnError !== undefined ?
     options.useInterimTilesOnError : true);
 
   /**