Move olx.source.BingMapsOptions to ol/source/BingMapsOptions

This commit is contained in:
Florent gravin
2018-03-28 13:59:05 +02:00
parent bc54693382
commit af4296d2bc
2 changed files with 22 additions and 104 deletions

View File

@@ -49,109 +49,6 @@ olx.render.State.prototype.resolution;
olx.render.State.prototype.rotation; olx.render.State.prototype.rotation;
/**
* @typedef {{cacheSize: (number|undefined),
* culture: (string|undefined),
* hidpi: (boolean|undefined),
* key: string,
* imagerySet: string,
* maxZoom: (number|undefined),
* reprojectionErrorThreshold: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* wrapX: (boolean|undefined),
* transition: (number|undefined)}}
*/
olx.source.BingMapsOptions;
/**
* Cache size. Default is `2048`.
* @type {number|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.cacheSize;
/**
* If `true` hidpi tiles will be requested. Default is `false`.
* @type {boolean|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.hidpi;
/**
* Culture code. Default is `en-us`.
* @type {string|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.culture;
/**
* Bing Maps API key. Get yours at http://www.bingmapsportal.com/.
* @type {string}
* @api
*/
olx.source.BingMapsOptions.prototype.key;
/**
* Type of imagery.
* @type {string}
* @api
*/
olx.source.BingMapsOptions.prototype.imagerySet;
/**
* Max zoom. Default is what's advertized by the BingMaps service (`21`
* currently).
* @type {number|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.maxZoom;
/**
* Maximum allowed reprojection error (in pixels). Default is `0.5`.
* Higher values can increase reprojection performance, but decrease precision.
* @type {number|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.reprojectionErrorThreshold;
/**
* Optional function to load a tile given a URL. The default is
* ```js
* function(imageTile, src) {
* imageTile.getImage().src = src;
* };
* ```
* @type {ol.TileLoadFunctionType|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.tileLoadFunction;
/**
* Whether to wrap the world horizontally. Default is `true`.
* @type {boolean|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.wrapX;
/**
* Duration of the opacity transition for rendering. To disable the opacity
* transition, pass `transition: 0`.
* @type {number|undefined}
* @api
*/
olx.source.BingMapsOptions.prototype.transition;
/** /**
* @typedef {{attributions: (ol.AttributionLike|undefined), * @typedef {{attributions: (ol.AttributionLike|undefined),
* distance: (number|undefined), * distance: (number|undefined),

View File

@@ -11,13 +11,34 @@ import TileImage from '../source/TileImage.js';
import {createOrUpdate, quadKey} from '../tilecoord.js'; import {createOrUpdate, quadKey} from '../tilecoord.js';
import {createXYZ, extentFromProjection} from '../tilegrid.js'; import {createXYZ, extentFromProjection} from '../tilegrid.js';
/**
* @typedef {Object} Options
* @property {number} [cacheSize=2048] Cache size.
* @property {boolean} [hidpi=false] If `true` hidpi tiles will be requested.
* @property {string} [culture='en-us'] Culture code.
* @property {string} key Bing Maps API key. Get yours at http://www.bingmapsportal.com/.
* @property {string} imagerySet Type of imagery.
* @property {number} [maxZoom=21] Max zoom. Default is what's advertized by the BingMaps service.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision.
* @property {ol.TileLoadFunctionType} [tileLoadFunction] Optional function to load a tile given a URL. The default is
* ```js
* function(imageTile, src) {
* imageTile.getImage().src = src;
* };
* ```
* @property {boolean} [wrapX=true] Whether to wrap the world horizontally.
* @property {number} [transition] Duration of the opacity transition for rendering.
* To disable the opacity transition, pass `transition: 0`.
*/
/** /**
* @classdesc * @classdesc
* Layer source for Bing Maps tile data. * Layer source for Bing Maps tile data.
* *
* @constructor * @constructor
* @extends {ol.source.TileImage} * @extends {ol.source.TileImage}
* @param {olx.source.BingMapsOptions} options Bing Maps options. * @param {module:ol/source/BingMaps~Options=} options Bing Maps options.
* @api * @api
*/ */
const BingMaps = function(options) { const BingMaps = function(options) {