Merge pull request #8075 from pfirpfel/move-olx.tilegrid-to-ol/tilegrid
Move olx.tilegrid.* to ol/tilegrid/*
This commit is contained in:
Andreas Hocevar
GitHub
234
externs/olx.js
234
externs/olx.js
@@ -647,237 +647,3 @@ olx.style.StyleOptions.prototype.text;
|
||||
* @api
|
||||
*/
|
||||
olx.style.StyleOptions.prototype.zIndex;
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {{extent: (ol.Extent|undefined),
|
||||
* minZoom: (number|undefined),
|
||||
* origin: (ol.Coordinate|undefined),
|
||||
* origins: (Array.<ol.Coordinate>|undefined),
|
||||
* resolutions: !Array.<number>,
|
||||
* sizes: (Array.<ol.Size>|undefined),
|
||||
* tileSize: (number|ol.Size|undefined),
|
||||
* tileSizes: (Array.<number|ol.Size>|undefined)}}
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions;
|
||||
|
||||
|
||||
/**
|
||||
* Extent for the tile grid. No tiles outside this extent will be requested by
|
||||
* {@link ol.source.Tile} sources. When no `origin` or `origins` are
|
||||
* configured, the `origin` will be set to the top-left corner of the extent.
|
||||
* @type {ol.Extent|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.extent;
|
||||
|
||||
|
||||
/**
|
||||
* Minimum zoom. Default is 0.
|
||||
* @type {number|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.minZoom;
|
||||
|
||||
|
||||
/**
|
||||
* The tile grid origin, i.e. where the `x` and `y` axes meet (`[z, 0, 0]`).
|
||||
* Tile coordinates increase left to right and upwards. If not specified,
|
||||
* `extent` or `origins` must be provided.
|
||||
* @type {ol.Coordinate|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.origin;
|
||||
|
||||
|
||||
/**
|
||||
* Tile grid origins, i.e. where the `x` and `y` axes meet (`[z, 0, 0]`), for
|
||||
* each zoom level. If given, the array length should match the length of the
|
||||
* `resolutions` array, i.e. each resolution can have a different origin. Tile
|
||||
* coordinates increase left to right and upwards. If not specified, `extent`
|
||||
* or `origin` must be provided.
|
||||
* @type {Array.<ol.Coordinate>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.origins;
|
||||
|
||||
|
||||
/**
|
||||
* Resolutions. The array index of each resolution needs to match the zoom
|
||||
* level. This means that even if a `minZoom` is configured, the resolutions
|
||||
* array will have a length of `maxZoom + 1`.
|
||||
* @type {!Array.<number>}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.resolutions;
|
||||
|
||||
|
||||
/**
|
||||
* Tile size. Default is `[256, 256]`.
|
||||
* @type {number|ol.Size|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.tileSize;
|
||||
|
||||
|
||||
/**
|
||||
* Tile sizes. If given, the array length should match the length of the
|
||||
* `resolutions` array, i.e. each resolution can have a different tile size.
|
||||
* @type {Array.<number|ol.Size>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.TileGridOptions.prototype.tileSizes;
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {{extent: (ol.Extent|undefined),
|
||||
* origin: (ol.Coordinate|undefined),
|
||||
* origins: (Array.<ol.Coordinate>|undefined),
|
||||
* resolutions: !Array.<number>,
|
||||
* matrixIds: !Array.<string>,
|
||||
* sizes: (Array.<ol.Size>|undefined),
|
||||
* tileSize: (number|ol.Size|undefined),
|
||||
* tileSizes: (Array.<number|ol.Size>|undefined)}}
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions;
|
||||
|
||||
|
||||
/**
|
||||
* Extent for the tile grid. No tiles outside this extent will be requested by
|
||||
* {@link ol.source.Tile} sources. When no `origin` or `origins` are
|
||||
* configured, the `origin` will be set to the top-left corner of the extent.
|
||||
* @type {ol.Extent|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.extent;
|
||||
|
||||
|
||||
/**
|
||||
* The tile grid origin, i.e. where the `x` and `y` axes meet (`[z, 0, 0]`).
|
||||
* Tile coordinates increase left to right and upwards. If not specified,
|
||||
* `extent` or `origins` must be provided.
|
||||
* @type {ol.Coordinate|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.origin;
|
||||
|
||||
|
||||
/**
|
||||
* Tile grid origins, i.e. where the `x` and `y` axes meet (`[z, 0, 0]`), for
|
||||
* each zoom level. If given, the array length should match the length of the
|
||||
* `resolutions` array, i.e. each resolution can have a different origin. Tile
|
||||
* coordinates increase left to right and upwards. If not specified, `extent` or
|
||||
* `origin` must be provided.
|
||||
* @type {Array.<ol.Coordinate>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.origins;
|
||||
|
||||
|
||||
/**
|
||||
* Resolutions. The array index of each resolution needs to match the zoom
|
||||
* level. This means that even if a `minZoom` is configured, the resolutions
|
||||
* array will have a length of `maxZoom + 1`
|
||||
* @type {!Array.<number>}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.resolutions;
|
||||
|
||||
|
||||
/**
|
||||
* matrix IDs. The length of this array needs to match the length of the
|
||||
* `resolutions` array.
|
||||
* @type {!Array.<string>}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.matrixIds;
|
||||
|
||||
|
||||
/**
|
||||
* Number of tile rows and columns of the grid for each zoom level. The values
|
||||
* here are the `TileMatrixWidth` and `TileMatrixHeight` advertised in the
|
||||
* GetCapabilities response of the WMTS, and define the grid's extent together
|
||||
* with the `origin`. An `extent` can be configured in addition, and will
|
||||
* further limit the extent for which tile requests are made by sources. Note
|
||||
* that when the top-left corner of the `extent` is used as `origin` or
|
||||
* `origins`, then the `y` value must be negative because OpenLayers tile
|
||||
* coordinates increase upwards.
|
||||
* @type {Array.<ol.Size>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.sizes;
|
||||
|
||||
|
||||
/**
|
||||
* Tile size.
|
||||
* @type {number|ol.Size|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.tileSize;
|
||||
|
||||
|
||||
/**
|
||||
* Tile sizes. The length of this array needs to match the length of the
|
||||
* `resolutions` array.
|
||||
* @type {Array.<number|ol.Size>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.tileSizes;
|
||||
|
||||
|
||||
/**
|
||||
* Number of tile columns that cover the grid's extent for each zoom level. Only
|
||||
* required when used with a source that has `wrapX` set to `true`, and only
|
||||
* when the grid's origin differs from the one of the projection's extent. The
|
||||
* array length has to match the length of the `resolutions` array, i.e. each
|
||||
* resolution will have a matching entry here.
|
||||
* @type {Array.<number>|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.WMTSOptions.prototype.widths;
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {{extent: (ol.Extent|undefined),
|
||||
* maxZoom: (number|undefined),
|
||||
* minZoom: (number|undefined),
|
||||
* tileSize: (number|ol.Size|undefined)}}
|
||||
*/
|
||||
olx.tilegrid.XYZOptions;
|
||||
|
||||
|
||||
/**
|
||||
* Extent for the tile grid. The origin for an XYZ tile grid is the top-left
|
||||
* corner of the extent. The zero level of the grid is defined by the
|
||||
* resolution at which one tile fits in the provided extent. If not provided,
|
||||
* the extent of the EPSG:3857 projection is used.
|
||||
* @type {ol.Extent|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.XYZOptions.prototype.extent;
|
||||
|
||||
|
||||
/**
|
||||
* Maximum zoom. The default is `ol.DEFAULT_MAX_ZOOM`. This determines the
|
||||
* number of levels in the grid set. For example, a `maxZoom` of 21 means there
|
||||
* are 22 levels in the grid set.
|
||||
* @type {number|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.XYZOptions.prototype.maxZoom;
|
||||
|
||||
|
||||
/**
|
||||
* Minimum zoom. Default is 0.
|
||||
* @type {number|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.XYZOptions.prototype.minZoom;
|
||||
|
||||
|
||||
/**
|
||||
* Tile size in pixels. Default is `[256, 256]`.
|
||||
* @type {number|ol.Size|undefined}
|
||||
* @api
|
||||
*/
|
||||
olx.tilegrid.XYZOptions.prototype.tileSize;
|
||||
|
||||
@@ -70,16 +70,28 @@ export function createForExtent(extent, opt_maxZoom, opt_tileSize, opt_corner) {
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {Object} XYZOptions
|
||||
* @property {module:ol/extent~Extent} [extent] Extent for the tile grid. The origin for an XYZ tile grid is the
|
||||
* top-left corner of the extent. The zero level of the grid is defined by the resolution at which one tile fits in the
|
||||
* provided extent. If not provided, the extent of the EPSG:3857 projection is used.
|
||||
* @property {number} [maxZoom] Maximum zoom. The default is `ol.DEFAULT_MAX_ZOOM`. This determines the number of levels
|
||||
* in the grid set. For example, a `maxZoom` of 21 means there are 22 levels in the grid set.
|
||||
* @property {number} [minZoom=0] Minimum zoom.
|
||||
* @property {number|module:ol/size~Size} [tileSize=[256, 256]] Tile size in pixels.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Creates a tile grid with a standard XYZ tiling scheme.
|
||||
* @param {olx.tilegrid.XYZOptions=} opt_options Tile grid options.
|
||||
* @param {module:ol/tilegrid~XYZOptions=} opt_options Tile grid options.
|
||||
* @return {!module:ol/tilegrid/TileGrid~TileGrid} Tile grid instance.
|
||||
* @api
|
||||
*/
|
||||
export function createXYZ(opt_options) {
|
||||
const options = /** @type {olx.tilegrid.TileGridOptions} */ ({});
|
||||
const options = /** @type {module:ol/tilegrid/TileGrid~Options} */ ({});
|
||||
assign(options, opt_options !== undefined ?
|
||||
opt_options : /** @type {olx.tilegrid.XYZOptions} */ ({}));
|
||||
opt_options : /** @type {module:ol/tilegrid~XYZOptions} */ ({}));
|
||||
if (options.extent === undefined) {
|
||||
options.extent = getProjection('EPSG:3857').getExtent();
|
||||
}
|
||||
|
||||
@@ -10,13 +10,40 @@ import {clamp} from '../math.js';
|
||||
import {toSize} from '../size.js';
|
||||
import {createOrUpdate as createOrUpdateTileCoord} from '../tilecoord.js';
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {Object} Options
|
||||
* @property {module:ol/extent~Extent} [extent] Extent for the tile grid. No tiles outside this
|
||||
* extent will be requested by {@link module:ol/source/Tile} sources. When no `origin` or
|
||||
* `origins` are configured, the `origin` will be set to the top-left corner of the extent.
|
||||
* @property {number} [minZoom=0] Minimum zoom.
|
||||
* @property {module:ol/coordinate~Coordinate} [origin] The tile grid origin, i.e. where the `x`
|
||||
* and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left to right and upwards. If not
|
||||
* specified, `extent` or `origins` must be provided.
|
||||
* @property {Array.<module:ol/coordinate~Coordinate>} [origins] Tile grid origins, i.e. where
|
||||
* the `x` and `y` axes meet (`[z, 0, 0]`), for each zoom level. If given, the array length
|
||||
* should match the length of the `resolutions` array, i.e. each resolution can have a different
|
||||
* origin. Tile coordinates increase left to right and upwards. If not specified, `extent` or
|
||||
* `origin` must be provided.
|
||||
* @property {!Array.<number>} resolutions Resolutions. The array index of each resolution needs
|
||||
* to match the zoom level. This means that even if a `minZoom` is configured, the resolutions
|
||||
* array will have a length of `maxZoom + 1`.
|
||||
* @property {Array.<module:ol/size~Size>} [sizes] Sizes.
|
||||
* @property {number|module:ol/size~Size} [tileSize] Tile size.
|
||||
* Default is `[256, 256]`.
|
||||
* @property {Array.<module:ol/size~Size>} [tileSizes] Tile sizes. If given, the array length
|
||||
* should match the length of the `resolutions` array, i.e. each resolution can have a different
|
||||
* tile size.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* Base class for setting the grid pattern for sources accessing tiled-image
|
||||
* servers.
|
||||
*
|
||||
* @constructor
|
||||
* @param {olx.tilegrid.TileGridOptions} options Tile grid options.
|
||||
* @param {module:ol/tilegrid/TileGrid~Options} options Tile grid options.
|
||||
* @struct
|
||||
* @api
|
||||
*/
|
||||
|
||||
@@ -6,13 +6,52 @@ import {find} from '../array.js';
|
||||
import {get as getProjection} from '../proj.js';
|
||||
import TileGrid from '../tilegrid/TileGrid.js';
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {Object} Options
|
||||
* @property {module:ol/extent~Extent} [extent] Extent for the tile grid. No tiles
|
||||
* outside this extent will be requested by {@link module:ol/source/Tile} sources.
|
||||
* When no `origin` or `origins` are configured, the `origin` will be set to the
|
||||
* top-left corner of the extent.
|
||||
* @property {module:ol/coordinate~Coordinate} [origin] The tile grid origin, i.e.
|
||||
* where the `x` and `y` axes meet (`[z, 0, 0]`). Tile coordinates increase left
|
||||
* to right and upwards. If not specified, `extent` or `origins` must be provided.
|
||||
* @property {Array.<module:ol/coordinate~Coordinate>} [origins] Tile grid origins,
|
||||
* i.e. where the `x` and `y` axes meet (`[z, 0, 0]`), for each zoom level. If
|
||||
* given, the array length should match the length of the `resolutions` array, i.e.
|
||||
* each resolution can have a different origin. Tile coordinates increase left to
|
||||
* right and upwards. If not specified, `extent` or `origin` must be provided.
|
||||
* @property {!Array.<number>} resolutions Resolutions. The array index of each
|
||||
* resolution needs to match the zoom level. This means that even if a `minZoom`
|
||||
* is configured, the resolutions array will have a length of `maxZoom + 1`
|
||||
* @property {!Array.<string>} matrixIds matrix IDs. The length of this array needs
|
||||
* to match the length of the `resolutions` array.
|
||||
* @property {Array.<module:ol/size~Size>} [sizes] Number of tile rows and columns
|
||||
* of the grid for each zoom level. The values here are the `TileMatrixWidth` and
|
||||
* `TileMatrixHeight` advertised in the GetCapabilities response of the WMTS, and
|
||||
* define the grid's extent together with the `origin`.
|
||||
* An `extent` can be configured in addition, and will further limit the extent for
|
||||
* which tile requests are made by sources. Note that when the top-left corner of
|
||||
* the `extent` is used as `origin` or `origins`, then the `y` value must be
|
||||
* negative because OpenLayers tile coordinates increase upwards.
|
||||
* @property {number|module:ol/size~Size} [tileSize] Tile size.
|
||||
* @property {Array.<module:ol/size~Size>} [tileSizes] Tile sizes. The length of
|
||||
* this array needs to match the length of the `resolutions` array.
|
||||
* @property {Array.<number>} [widths] Number of tile columns that cover the grid's
|
||||
* extent for each zoom level. Only required when used with a source that has `wrapX`
|
||||
* set to `true`, and only when the grid's origin differs from the one of the
|
||||
* projection's extent. The array length has to match the length of the `resolutions`
|
||||
* array, i.e. each resolution will have a matching entry here.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* Set the grid pattern for sources accessing WMTS tiled-image servers.
|
||||
*
|
||||
* @constructor
|
||||
* @extends {module:ol/tilegrid/TileGrid~TileGrid}
|
||||
* @param {olx.tilegrid.WMTSOptions} options WMTS options.
|
||||
* @param {module:ol/tilegrid/WMTS~Options} options WMTS options.
|
||||
* @struct
|
||||
* @api
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user