Move olx.layer.TileOptions to ol/layer/Tile

This commit is contained in:
Roman Zoller
2018-03-23 09:57:25 +01:00
parent 34d5a38a9e
commit c24b369523
2 changed files with 25 additions and 102 deletions

View File

@@ -5,107 +5,6 @@
let olx;
/**
* @typedef {{opacity: (number|undefined),
* preload: (number|undefined),
* source: (ol.source.Tile|undefined),
* map: (ol.PluggableMap|undefined),
* visible: (boolean|undefined),
* extent: (ol.Extent|undefined),
* minResolution: (number|undefined),
* maxResolution: (number|undefined),
* useInterimTilesOnError: (boolean|undefined),
* zIndex: (number|undefined)}}
*/
olx.layer.TileOptions;
/**
* Opacity (0, 1). Default is `1`.
* @type {number|undefined}
* @api
*/
olx.layer.TileOptions.prototype.opacity;
/**
* Preload. Load low-resolution tiles up to `preload` levels. By default
* `preload` is `0`, which means no preloading.
* @type {number|undefined}
* @api
*/
olx.layer.TileOptions.prototype.preload;
/**
* Source for this layer.
* @type {ol.source.Tile}
* @api
*/
olx.layer.TileOptions.prototype.source;
/**
* 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}.
* @type {ol.PluggableMap|undefined}
* @api
*/
olx.layer.TileOptions.prototype.map;
/**
* Visibility. Default is `true` (visible).
* @type {boolean|undefined}
* @api
*/
olx.layer.TileOptions.prototype.visible;
/**
* The bounding extent for layer rendering. The layer will not be rendered
* outside of this extent.
* @type {ol.Extent|undefined}
* @api
*/
olx.layer.TileOptions.prototype.extent;
/**
* The minimum resolution (inclusive) at which this layer will be visible.
* @type {number|undefined}
* @api
*/
olx.layer.TileOptions.prototype.minResolution;
/**
* The maximum resolution (exclusive) below which this layer will be visible.
* @type {number|undefined}
* @api
*/
olx.layer.TileOptions.prototype.maxResolution;
/**
* Use interim tiles on error. Default is `true`.
* @type {boolean|undefined}
* @api
*/
olx.layer.TileOptions.prototype.useInterimTilesOnError;
/**
* The z-index for layer rendering. At rendering time, the layers will be
* ordered, first by Z-index and then by position. The default Z-index is 0.
* @type {number|undefined}
* @api
*/
olx.layer.TileOptions.prototype.zIndex;
/**
* @typedef {{renderOrder: (ol.RenderOrderFunction|null|undefined),
* minResolution: (number|undefined),

View File

@@ -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) {