Module type for ol.source.Source

This commit is contained in:
Frederic Junod
2018-04-04 12:04:57 +02:00
parent 3dbabb734b
commit 6f3957786a
5 changed files with 10 additions and 10 deletions

View File

@@ -24,7 +24,7 @@ import SourceState from '../source/State.js';
* visible.
* @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
* be visible.
* @property {ol.source.Source} [source] Source for this layer. If not provided to the constructor,
* @property {module:ol/source/Source~Source} [source] Source for this layer. If not provided to the constructor,
* the source can be set by calling {@link ol.layer.Layer#setSource layer.setSource(source)} after
* construction.
*/
@@ -142,13 +142,13 @@ Layer.prototype.getLayerStatesArray = function(opt_states) {
/**
* Get the layer source.
* @return {ol.source.Source} The layer source (or `null` if not yet set).
* @return {module:ol/source/Source~Source} The layer source (or `null` if not yet set).
* @observable
* @api
*/
Layer.prototype.getSource = function() {
const source = this.get(LayerProperty.SOURCE);
return /** @type {ol.source.Source} */ (source) || null;
return /** @type {module:ol/source/Source~Source} */ (source) || null;
};
@@ -226,7 +226,7 @@ Layer.prototype.setMap = function(map) {
/**
* Set the layer source.
* @param {ol.source.Source} source The layer source.
* @param {module:ol/source/Source~Source} source The layer source.
* @observable
* @api
*/

View File

@@ -85,7 +85,7 @@ inherits(ImageSourceEvent, Event);
*
* @constructor
* @abstract
* @extends {ol.source.Source}
* @extends {module:ol/source/Source~Source}
* @param {module:ol/source/Image~Options} options Single image source options.
* @api
*/

View File

@@ -84,7 +84,7 @@ inherits(RasterSourceEvent, Event);
/**
* @typedef {Object} Options
* @property {Array.<ol.source.Source>} sources Input sources.
* @property {Array.<module:ol/source/Source~Source>} sources Input sources.
* @property {ol.RasterOperation} [operation] Raster operation.
* The operation will be called with data from input sources
* and the output will be assigned to the raster source.
@@ -436,7 +436,7 @@ function getLayerStatesArray(renderers) {
/**
* Create renderers for all sources.
* @param {Array.<ol.source.Source>} sources The sources.
* @param {Array.<module:ol/source/Source~Source>} sources The sources.
* @return {Array.<ol.renderer.canvas.Layer>} Array of layer renderers.
*/
function createRenderers(sources) {
@@ -451,7 +451,7 @@ function createRenderers(sources) {
/**
* Create a renderer for the provided source.
* @param {ol.source.Source} source The source.
* @param {module:ol/source/Source~Source} source The source.
* @return {ol.renderer.canvas.Layer} The renderer.
*/
function createRenderer(source) {

View File

@@ -35,7 +35,7 @@ import {wrapX, getForProjection as getTileGridForProjection} from '../tilegrid.j
*
* @constructor
* @abstract
* @extends {ol.source.Source}
* @extends {module:ol/source/Source~Source}
* @param {module:ol/source/Tile~Options=} options SourceTile source options.
* @api
*/

View File

@@ -141,7 +141,7 @@ inherits(VectorSourceEvent, Event);
* vector data that is optimized for rendering.
*
* @constructor
* @extends {ol.source.Source}
* @extends {module:ol/source/Source~Source}
* @fires ol.source.Vector.Event
* @param {module:ol/source/Vector~Options=} opt_options Vector source options.
* @api