ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move olx.tilegrid.WMTSOptions to ol/tilegrid/WMTS

Browse Source
This commit is contained in:
Michael Kuenzli
2018-04-17 14:35:50 +02:00
parent ff488c8214
commit 2178393e18
2 changed files with 40 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/ol/tilegrid/WMTS.js
View File

@@ -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
*/