Move olx.layer.VectorTileOptions to ol/layer/VectorTile
This commit is contained in:
@@ -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) {
|
||||
|
||||
Reference in New Issue
Block a user