Module type for ol.PluggableMap
This commit is contained in:
@@ -68,7 +68,7 @@ const Control = function(options) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @type {ol.PluggableMap}
|
* @type {module:ol/PluggableMap~PluggableMap}
|
||||||
*/
|
*/
|
||||||
this.map_ = null;
|
this.map_ = null;
|
||||||
|
|
||||||
@@ -103,7 +103,7 @@ Control.prototype.disposeInternal = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the map associated with this control.
|
* Get the map associated with this control.
|
||||||
* @return {ol.PluggableMap} Map.
|
* @return {module:ol/PluggableMap~PluggableMap} Map.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
Control.prototype.getMap = function() {
|
Control.prototype.getMap = function() {
|
||||||
@@ -115,7 +115,7 @@ Control.prototype.getMap = function() {
|
|||||||
* Remove the control from its current map and attach it to the new map.
|
* Remove the control from its current map and attach it to the new map.
|
||||||
* Subclasses may set up event handlers to get notified about changes to
|
* Subclasses may set up event handlers to get notified about changes to
|
||||||
* the map here.
|
* the map here.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @override
|
* @override
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ const OverviewMap = function(opt_options) {
|
|||||||
this.ovmapDiv_.className = 'ol-overviewmap-map';
|
this.ovmapDiv_.className = 'ol-overviewmap-map';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @type {ol.PluggableMap}
|
* @type {module:ol/PluggableMap~PluggableMap}
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
this.ovmap_ = new PluggableMap({
|
this.ovmap_ = new PluggableMap({
|
||||||
@@ -588,7 +588,7 @@ OverviewMap.prototype.getCollapsed = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the overview map.
|
* Return the overview map.
|
||||||
* @return {ol.PluggableMap} Overview map.
|
* @return {module:ol/PluggableMap~PluggableMap} Overview map.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
OverviewMap.prototype.getOverviewMap = function() {
|
OverviewMap.prototype.getOverviewMap = function() {
|
||||||
|
|||||||
@@ -177,7 +177,7 @@ Layer.prototype.handleSourcePropertyChange_ = function() {
|
|||||||
*
|
*
|
||||||
* To add the layer to a map and have it managed by the map, use
|
* To add the layer to a map and have it managed by the map, use
|
||||||
* {@link ol.Map#addLayer} instead.
|
* {@link ol.Map#addLayer} instead.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
Layer.prototype.setMap = function(map) {
|
Layer.prototype.setMap = function(map) {
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ const RenderBox = function(className) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @type {ol.PluggableMap}
|
* @type {module:ol/PluggableMap~PluggableMap}
|
||||||
*/
|
*/
|
||||||
this.map_ = null;
|
this.map_ = null;
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ RenderBox.prototype.render_ = function() {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
*/
|
*/
|
||||||
RenderBox.prototype.setMap = function(map) {
|
RenderBox.prototype.setMap = function(map) {
|
||||||
if (this.map_) {
|
if (this.map_) {
|
||||||
|
|||||||
@@ -145,7 +145,7 @@ LayerRenderer.prototype.scheduleExpireCache = function(frameState, tileSource) {
|
|||||||
if (tileSource.canExpireCache()) {
|
if (tileSource.canExpireCache()) {
|
||||||
/**
|
/**
|
||||||
* @param {ol.source.Tile} tileSource Tile source.
|
* @param {ol.source.Tile} tileSource Tile source.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
||||||
*/
|
*/
|
||||||
const postRenderFunction = function(tileSource, map, frameState) {
|
const postRenderFunction = function(tileSource, map, frameState) {
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ import {compose as composeTransform, invert as invertTransform, setFromArray as
|
|||||||
* @abstract
|
* @abstract
|
||||||
* @extends {module:ol/Disposable~Disposabl}
|
* @extends {module:ol/Disposable~Disposabl}
|
||||||
* @param {Element} container Container.
|
* @param {Element} container Container.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @struct
|
* @struct
|
||||||
*/
|
*/
|
||||||
const MapRenderer = function(container, map) {
|
const MapRenderer = function(container, map) {
|
||||||
@@ -26,7 +26,7 @@ const MapRenderer = function(container, map) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @type {ol.PluggableMap}
|
* @type {module:ol/PluggableMap~PluggableMap}
|
||||||
*/
|
*/
|
||||||
this.map_ = map;
|
this.map_ = map;
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ MapRenderer.prototype.removeLayerRenderers = function() {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
||||||
*/
|
*/
|
||||||
function expireIconCache(map, frameState) {
|
function expireIconCache(map, frameState) {
|
||||||
@@ -246,7 +246,7 @@ MapRenderer.prototype.getLayerRenderers = function() {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.PluggableMap} Map.
|
* @return {module:ol/PluggableMap~PluggableMap} Map.
|
||||||
*/
|
*/
|
||||||
MapRenderer.prototype.getMap = function() {
|
MapRenderer.prototype.getMap = function() {
|
||||||
return this.map_;
|
return this.map_;
|
||||||
@@ -293,7 +293,7 @@ MapRenderer.prototype.renderFrame = UNDEFINED;
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ import SourceState from '../../source/State.js';
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.renderer.Map}
|
* @extends {ol.renderer.Map}
|
||||||
* @param {Element} container Container.
|
* @param {Element} container Container.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
const CanvasMapRenderer = function(container, map) {
|
const CanvasMapRenderer = function(container, map) {
|
||||||
@@ -76,7 +76,7 @@ CanvasMapRenderer['handles'] = function(type) {
|
|||||||
/**
|
/**
|
||||||
* Create the map renderer.
|
* Create the map renderer.
|
||||||
* @param {Element} container Container.
|
* @param {Element} container Container.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @return {ol.renderer.canvas.Map} The map renderer.
|
* @return {ol.renderer.canvas.Map} The map renderer.
|
||||||
*/
|
*/
|
||||||
CanvasMapRenderer['create'] = function(container, map) {
|
CanvasMapRenderer['create'] = function(container, map) {
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.renderer.Map}
|
* @extends {ol.renderer.Map}
|
||||||
* @param {Element} container Container.
|
* @param {Element} container Container.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
const WebGLMapRenderer = function(container, map) {
|
const WebGLMapRenderer = function(container, map) {
|
||||||
@@ -141,7 +141,7 @@ const WebGLMapRenderer = function(container, map) {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
|
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
|
||||||
* @return {boolean} false.
|
* @return {boolean} false.
|
||||||
* @this {ol.renderer.webgl.Map}
|
* @this {ol.renderer.webgl.Map}
|
||||||
@@ -186,7 +186,7 @@ WebGLMapRenderer['handles'] = function(type) {
|
|||||||
/**
|
/**
|
||||||
* Create the map renderer.
|
* Create the map renderer.
|
||||||
* @param {Element} container Container.
|
* @param {Element} container Container.
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @return {ol.renderer.webgl.Map} The map renderer.
|
* @return {ol.renderer.webgl.Map} The map renderer.
|
||||||
*/
|
*/
|
||||||
WebGLMapRenderer['create'] = function(container, map) {
|
WebGLMapRenderer['create'] = function(container, map) {
|
||||||
@@ -310,7 +310,7 @@ WebGLMapRenderer.prototype.disposeInternal = function() {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.PluggableMap} map Map.
|
* @param {module:ol/PluggableMap~PluggableMap} map Map.
|
||||||
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
* @param {module:ol/PluggableMap~FrameState} frameState Frame state.
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user