Module type for ol.source.Image

This commit is contained in:
Frederic Junod
2018-04-04 12:19:06 +02:00
parent 6f3957786a
commit e77986c86c
9 changed files with 12 additions and 12 deletions

View File

@@ -22,7 +22,7 @@ import Layer from '../layer/Layer.js';
* this layer in its layers collection, and the layer will be rendered on top. This is useful for * this layer in its layers collection, and the layer will be rendered on top. This is useful for
* temporary layers. The standard way to add a layer to a map and have it managed by the map is to * temporary layers. The standard way to add a layer to a map and have it managed by the map is to
* use {@link ol.Map#addLayer}. * use {@link ol.Map#addLayer}.
* @property {ol.source.Image} [source] Source for this layer. * @property {module:ol/source/Image~ImageSource} [source] Source for this layer.
*/ */
@@ -57,9 +57,9 @@ inherits(ImageLayer, Layer);
/** /**
* Return the associated {@link ol.source.Image source} of the image layer. * Return the associated {@link module:ol/source/Image~ImageSource source} of the image layer.
* @function * @function
* @return {ol.source.Image} Source. * @return {module:ol/source/Image~ImageSource} Source.
* @api * @api
*/ */
ImageLayer.prototype.getSource; ImageLayer.prototype.getSource;

View File

@@ -14,7 +14,7 @@ import Triangulation from '../reproj/Triangulation.js';
/** /**
* @classdesc * @classdesc
* Class encapsulating single reprojected image. * Class encapsulating single reprojected image.
* See {@link ol.source.Image}. * See {@link module:ol/source/Image~ImageSource}.
* *
* @constructor * @constructor
* @extends {module:ol/ImageBase~ImageBase} * @extends {module:ol/ImageBase~ImageBase}

View File

@@ -43,7 +43,7 @@ const ImageSourceEventType = {
/** /**
* @classdesc * @classdesc
* Events emitted by {@link ol.source.Image} instances are instances of this * Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this
* type. * type.
* *
* @constructor * @constructor

View File

@@ -50,7 +50,7 @@ import {appendParams} from '../uri.js';
* *
* @constructor * @constructor
* @fires ol.source.Image.Event * @fires ol.source.Image.Event
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @param {module:ol/source/ImageArcGISRest~Options=} opt_options Image ArcGIS Rest Options. * @param {module:ol/source/ImageArcGISRest~Options=} opt_options Image ArcGIS Rest Options.
* @api * @api
*/ */

View File

@@ -32,7 +32,7 @@ import ImageSource from '../source/Image.js';
* Base class for image sources where a canvas element is the image. * Base class for image sources where a canvas element is the image.
* *
* @constructor * @constructor
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @param {module:ol/source/ImageCanvas~Options=} options ImageCanvas options. * @param {module:ol/source/ImageCanvas~Options=} options ImageCanvas options.
* @api * @api
*/ */

View File

@@ -34,7 +34,7 @@ import {appendParams} from '../uri.js';
* *
* @constructor * @constructor
* @fires ol.source.Image.Event * @fires ol.source.Image.Event
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @param {module:ol/source/ImageMapGuide~Options=} options ImageMapGuide options. * @param {module:ol/source/ImageMapGuide~Options=} options ImageMapGuide options.
* @api * @api
*/ */

View File

@@ -33,7 +33,7 @@ import ImageSource, {defaultImageLoadFunction} from '../source/Image.js';
* A layer source for displaying a single, static image. * A layer source for displaying a single, static image.
* *
* @constructor * @constructor
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @param {module:ol/source/ImageStatic~Options=} options ImageStatic options. * @param {module:ol/source/ImageStatic~Options=} options ImageStatic options.
* @api * @api
*/ */

View File

@@ -49,7 +49,7 @@ import {appendParams} from '../uri.js';
* *
* @constructor * @constructor
* @fires ol.source.Image.Event * @fires ol.source.Image.Event
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @param {module:ol/source/ImageWMS~Options=} [opt_options] ImageWMS options. * @param {module:ol/source/ImageWMS~Options=} [opt_options] ImageWMS options.
* @api * @api
*/ */

View File

@@ -109,7 +109,7 @@ inherits(RasterSourceEvent, Event);
* output pixel values. * output pixel values.
* *
* @constructor * @constructor
* @extends {ol.source.Image} * @extends {module:ol/source/Image~ImageSource}
* @fires ol.source.Raster.Event * @fires ol.source.Raster.Event
* @param {module:ol/source/Raster~Options=} options Options. * @param {module:ol/source/Raster~Options=} options Options.
* @api * @api
@@ -467,7 +467,7 @@ function createRenderer(source) {
/** /**
* Create an image renderer for the provided source. * Create an image renderer for the provided source.
* @param {ol.source.Image} source The source. * @param {module:ol/source/Image~ImageSource} source The source.
* @return {ol.renderer.canvas.Layer} The renderer. * @return {ol.renderer.canvas.Layer} The renderer.
*/ */
function createImageRenderer(source) { function createImageRenderer(source) {