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

Move olx.tilegrid.XYZOptions to ol/tilegrid

Browse Source
This commit is contained in:
Michael Kuenzli
2018-04-17 14:46:51 +02:00
parent 2178393e18
commit 310b9256eb
2 changed files with 14 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
externs/olx.js
View File

@@ -647,49 +647,3 @@ olx.style.StyleOptions.prototype.text;
* @api * @api
*/ */
olx.style.StyleOptions.prototype.zIndex; olx.style.StyleOptions.prototype.zIndex;
/**
* @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;

16
src/ol/tilegrid.js
View File

@@ -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. * 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. * @return {!module:ol/tilegrid/TileGrid~TileGrid} Tile grid instance.
* @api * @api
*/ */
export function createXYZ(opt_options) { export function createXYZ(opt_options) {
const options = /** @type {module:ol/tilegrid/TileGrid~Options} */ ({}); const options = /** @type {module:ol/tilegrid/TileGrid~Options} */ ({});
assign(options, opt_options !== undefined ? assign(options, opt_options !== undefined ?
opt_options : /** @type {olx.tilegrid.XYZOptions} */ ({})); opt_options : /** @type {module:ol/tilegrid~XYZOptions} */ ({}));
if (options.extent === undefined) { if (options.extent === undefined) {
options.extent = getProjection('EPSG:3857').getExtent(); options.extent = getProjection('EPSG:3857').getExtent();
} }