Get rid of olx.js and typedef.js typedefs for ol

This commit is contained in:
Andreas Hocevar
2018-03-08 18:42:57 +01:00
parent 8f0ffe2043
commit 95d6251dbb
198 changed files with 2262 additions and 2698 deletions

View File

@@ -3,12 +3,20 @@
*/
/**
* An array of three numbers representing the location of a tile in a tile
* grid. The order is `z`, `x`, and `y`. `z` is the zoom level.
* @typedef {Array.<number>} TileCoord
* @api
*/
/**
* @param {number} z Z.
* @param {number} x X.
* @param {number} y Y.
* @param {ol.TileCoord=} opt_tileCoord Tile coordinate.
* @return {ol.TileCoord} Tile coordinate.
* @param {module:ol/tilecoord~TileCoord=} opt_tileCoord Tile coordinate.
* @return {module:ol/tilecoord~TileCoord} Tile coordinate.
*/
export function createOrUpdate(z, x, y, opt_tileCoord) {
if (opt_tileCoord !== undefined) {
@@ -35,7 +43,7 @@ export function getKeyZXY(z, x, y) {
/**
* Get the key for a tile coord.
* @param {ol.TileCoord} tileCoord The tile coord.
* @param {module:ol/tilecoord~TileCoord} tileCoord The tile coord.
* @return {string} Key.
*/
export function getKey(tileCoord) {
@@ -46,7 +54,7 @@ export function getKey(tileCoord) {
/**
* Get a tile coord given a key.
* @param {string} key The tile coord key.
* @return {ol.TileCoord} The tile coord.
* @return {module:ol/tilecoord~TileCoord} The tile coord.
*/
export function fromKey(key) {
return key.split('/').map(Number);
@@ -54,7 +62,7 @@ export function fromKey(key) {
/**
* @param {ol.TileCoord} tileCoord Tile coord.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coord.
* @return {number} Hash.
*/
export function hash(tileCoord) {
@@ -63,7 +71,7 @@ export function hash(tileCoord) {
/**
* @param {ol.TileCoord} tileCoord Tile coord.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coord.
* @return {string} Quad key.
*/
export function quadKey(tileCoord) {
@@ -88,8 +96,8 @@ export function quadKey(tileCoord) {
/**
* @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {!ol.tilegrid.TileGrid} tileGrid Tile grid.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {!module:ol/tilegrid~TileGrid} tileGrid Tile grid.
* @return {boolean} Tile coordinate is within extent and zoom level range.
*/
export function withinExtentAndZ(tileCoord, tileGrid) {