Module type for ol.source.State

This commit is contained in:
Frederic Junod
2018-04-04 11:56:52 +02:00
parent 6ce42464b3
commit e283193ff4
8 changed files with 12 additions and 12 deletions

View File

@@ -169,7 +169,7 @@ BaseLayer.prototype.getOpacity = function() {
/**
* @abstract
* @return {ol.source.State} Source state.
* @return {module:ol/source/State~State} Source state.
*/
BaseLayer.prototype.getSourceState = function() {};

View File

@@ -73,7 +73,7 @@ inherits(ImageSourceEvent, Event);
* @property {module:ol/extent~Extent} [extent]
* @property {module:ol/proj~ProjectionLike} projection
* @property {Array.<number>} [resolutions]
* @property {ol.source.State} [state]
* @property {module:ol/source/State~State} [state]
*/

View File

@@ -23,7 +23,7 @@ import ImageSource from '../source/Image.js';
* width and height of the map viewport, and so on. Must be `1` or higher.
* @property {Array.<number>} [resolutions] Resolutions.
* If specified, new canvases will be created for these resolutions
* @property {ol.source.State} [state] Source state.
* @property {module:ol/source/State~State} [state] Source state.
*/

View File

@@ -12,7 +12,7 @@ import SourceState from '../source/State.js';
* @typedef {Object} Options
* @property {ol.AttributionLike} [attributions]
* @property {module:ol/proj~ProjectionLike} projection
* @property {ol.source.State} [state]
* @property {module:ol/source/State~State} [state]
* @property {boolean} [wrapX]
*/
@@ -49,7 +49,7 @@ const Source = function(options) {
/**
* @private
* @type {ol.source.State}
* @type {module:ol/source/State~State}
*/
this.state_ = options.state !== undefined ?
options.state : SourceState.READY;
@@ -129,8 +129,8 @@ Source.prototype.getResolutions = function() {};
/**
* Get the state of the source, see {@link ol.source.State} for possible states.
* @return {ol.source.State} State.
* Get the state of the source, see {@link module:ol/source/State~State} for possible states.
* @return {module:ol/source/State~State} State.
* @api
*/
Source.prototype.getState = function() {
@@ -170,7 +170,7 @@ Source.prototype.setAttributions = function(attributions) {
/**
* Set the state of the source.
* @param {ol.source.State} state State.
* @param {module:ol/source/State~State} state State.
* @protected
*/
Source.prototype.setState = function(state) {

View File

@@ -20,7 +20,7 @@ import {wrapX, getForProjection as getTileGridForProjection} from '../tilegrid.j
* @property {boolean} [opaque]
* @property {number} [tilePixelRatio]
* @property {module:ol/proj~ProjectionLike} [projection]
* @property {ol.source.State} [state]
* @property {module:ol/source/State~State} [state]
* @property {ol.tilegrid.TileGrid} [tileGrid]
* @property {boolean} [wrapX=true]
* @property {number} [transition]

View File

@@ -26,7 +26,7 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
* @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {boolean} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision.
* @property {ol.source.State} [state] Source state.
* @property {module:ol/source/State~State} [state] Source state.
* @property {function(new: ol.ImageTile, ol.TileCoord,
* ol.TileState, string, ?string,
* ol.TileLoadFunctionType)} [tileClass] Class used to instantiate image tiles.

View File

@@ -15,7 +15,7 @@ import {getKeyZXY} from '../tilecoord.js';
* @property {module:ol/extent~Extent} [extent]
* @property {boolean} [opaque]
* @property {module:ol/proj~ProjectionLike} [projection]
* @property {ol.source.State} [state]
* @property {module:ol/source/State~State} [state]
* @property {ol.tilegrid.TileGrid} [tileGrid]
* @property {module:ol/Tile~LoadFunction} tileLoadFunction
* @property {number} [tilePixelRatio]

View File

@@ -20,7 +20,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid.
* boundaries or TopoJSON sources) allows the renderer to optimise fill and
* stroke operations.
* @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {ol.source.State} [state] Source state.
* @property {module:ol/source/State~State} [state] Source state.
* @property {function(new: ol.VectorTile, ol.TileCoord,
* ol.TileState, string, ?string,
* ol.TileLoadFunctionType)} [tileClass] Class used to instantiate image tiles.