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

Move olx.tilegrid.TileGridOptions to ol/tilegrid/TileGrid

Browse Source
This commit is contained in:
Michael Kuenzli
2018-04-17 14:17:13 +02:00
parent bd66034d7d
commit ff488c8214
3 changed files with 29 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
externs/olx.js
View File

@@ -649,86 +649,6 @@ olx.style.StyleOptions.prototype.text;
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),

2
src/ol/tilegrid.js
View File

@@ -77,7 +77,7 @@ export function createForExtent(extent, opt_maxZoom, opt_tileSize, opt_corner) {
* @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} */ ({}));
if (options.extent === undefined) {

29
src/ol/tilegrid/TileGrid.js
View File

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