Change 'Image' type to 'HTMLImageElement'

This commit is contained in:
Frederic Junod
2018-06-28 13:44:09 +02:00
parent 52e286b03c
commit 0c300d651f
12 changed files with 22 additions and 22 deletions

View File

@@ -50,7 +50,7 @@ const ImageWrapper = function(extent, resolution, pixelRatio, src, crossOrigin,
/** /**
* @private * @private
* @type {HTMLCanvasElement|Image|HTMLVideoElement} * @type {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement}
*/ */
this.image_ = new Image(); this.image_ = new Image();
if (crossOrigin !== null) { if (crossOrigin !== null) {
@@ -139,7 +139,7 @@ ImageWrapper.prototype.load = function() {
/** /**
* @param {HTMLCanvasElement|Image|HTMLVideoElement} image Image. * @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image.
*/ */
ImageWrapper.prototype.setImage = function(image) { ImageWrapper.prototype.setImage = function(image) {
this.image_ = image; this.image_ = image;

View File

@@ -65,7 +65,7 @@ ImageBase.prototype.getExtent = function() {
/** /**
* @abstract * @abstract
* @return {HTMLCanvasElement|Image|HTMLVideoElement} Image. * @return {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} Image.
*/ */
ImageBase.prototype.getImage = function() {}; ImageBase.prototype.getImage = function() {};

View File

@@ -44,7 +44,7 @@ const ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction,
/** /**
* @private * @private
* @type {Image|HTMLCanvasElement} * @type {HTMLImageElement|HTMLCanvasElement}
*/ */
this.image_ = new Image(); this.image_ = new Image();
if (crossOrigin !== null) { if (crossOrigin !== null) {

View File

@@ -29,13 +29,13 @@ const CanvasImageReplay = function(
/** /**
* @private * @private
* @type {HTMLCanvasElement|HTMLVideoElement|Image} * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement}
*/ */
this.hitDetectionImage_ = null; this.hitDetectionImage_ = null;
/** /**
* @private * @private
* @type {HTMLCanvasElement|HTMLVideoElement|Image} * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement}
*/ */
this.image_ = null; this.image_ = null;

View File

@@ -100,7 +100,7 @@ const CanvasImmediateRenderer = function(context, pixelRatio, extent, transform,
/** /**
* @private * @private
* @type {HTMLCanvasElement|HTMLVideoElement|Image} * @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement}
*/ */
this.image_ = null; this.image_ = null;

View File

@@ -652,7 +652,7 @@ CanvasReplay.prototype.replay_ = function(
case CanvasInstruction.DRAW_IMAGE: case CanvasInstruction.DRAW_IMAGE:
d = /** @type {number} */ (instruction[1]); d = /** @type {number} */ (instruction[1]);
dd = /** @type {number} */ (instruction[2]); dd = /** @type {number} */ (instruction[2]);
image = /** @type {HTMLCanvasElement|HTMLVideoElement|Image} */ image = /** @type {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} */
(instruction[3]); (instruction[3]);
// Remaining arguments in DRAW_IMAGE are in alphabetical order // Remaining arguments in DRAW_IMAGE are in alphabetical order
anchorX = /** @type {number} */ (instruction[4]); anchorX = /** @type {number} */ (instruction[4]);

View File

@@ -83,7 +83,7 @@ IntermediateCanvasRenderer.prototype.composeFrame = function(frameState, layerSt
/** /**
* @abstract * @abstract
* @return {HTMLCanvasElement|HTMLVideoElement|Image} Canvas. * @return {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} Canvas.
*/ */
IntermediateCanvasRenderer.prototype.getImage = function() {}; IntermediateCanvasRenderer.prototype.getImage = function() {};

View File

@@ -84,7 +84,7 @@ function enlargeClipPoint(centroidX, centroidY, x, y) {
* @param {module:ol/reproj/Triangulation} triangulation * @param {module:ol/reproj/Triangulation} triangulation
* Calculated triangulation. * Calculated triangulation.
* @param {Array.<{extent: module:ol/extent~Extent, * @param {Array.<{extent: module:ol/extent~Extent,
* image: (HTMLCanvasElement|Image|HTMLVideoElement)}>} sources * image: (HTMLCanvasElement|HTMLImageElement|HTMLVideoElement)}>} sources
* Array of sources. * Array of sources.
* @param {number} gutter Gutter of the sources. * @param {number} gutter Gutter of the sources.
* @param {boolean=} opt_renderEdges Render reprojection edges. * @param {boolean=} opt_renderEdges Render reprojection edges.

View File

@@ -80,7 +80,7 @@ inherits(CustomTile, Tile);
/** /**
* Get the image element for this tile. * Get the image element for this tile.
* @return {Image} Image. * @return {HTMLImageElement} Image.
*/ */
CustomTile.prototype.getImage = function() { CustomTile.prototype.getImage = function() {
return null; return null;

View File

@@ -29,7 +29,7 @@ import ImageStyle from '../style/Image.js';
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that you must provide a * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that you must provide a
* `crossOrigin` value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. * `crossOrigin` value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer.
* See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail. * See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail.
* @property {Image|HTMLCanvasElement} [img] Image object for the icon. If the `src` option is not provided then the * @property {HTMLImageElement|HTMLCanvasElement} [img] Image object for the icon. If the `src` option is not provided then the
* provided image must already be loaded. And in that case, it is required * provided image must already be loaded. And in that case, it is required
* to provide the size of the image, with the `imgSize` option. * to provide the size of the image, with the `imgSize` option.
* @property {Array.<number>} [offset=[0, 0]] Offset, which, together with the size and the offset origin, define the * @property {Array.<number>} [offset=[0, 0]] Offset, which, together with the size and the offset origin, define the
@@ -106,7 +106,7 @@ const Icon = function(opt_options) {
options.crossOrigin !== undefined ? options.crossOrigin : null; options.crossOrigin !== undefined ? options.crossOrigin : null;
/** /**
* @type {Image|HTMLCanvasElement} * @type {HTMLImageElement|HTMLCanvasElement}
*/ */
const image = options.img !== undefined ? options.img : null; const image = options.img !== undefined ? options.img : null;
@@ -299,7 +299,7 @@ Icon.prototype.getColor = function() {
/** /**
* Get the image icon. * Get the image icon.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {Image|HTMLCanvasElement} Image or Canvas element. * @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
* @override * @override
* @api * @api
*/ */

View File

@@ -11,7 +11,7 @@ import {shared as iconImageCache} from '../style/IconImageCache.js';
/** /**
* @constructor * @constructor
* @param {Image|HTMLCanvasElement} image Image. * @param {HTMLImageElement|HTMLCanvasElement} image Image.
* @param {string|undefined} src Src. * @param {string|undefined} src Src.
* @param {module:ol/size~Size} size Size. * @param {module:ol/size~Size} size Size.
* @param {?string} crossOrigin Cross origin. * @param {?string} crossOrigin Cross origin.
@@ -25,13 +25,13 @@ const IconImage = function(image, src, size, crossOrigin, imageState, color) {
/** /**
* @private * @private
* @type {Image|HTMLCanvasElement} * @type {HTMLImageElement|HTMLCanvasElement}
*/ */
this.hitDetectionImage_ = null; this.hitDetectionImage_ = null;
/** /**
* @private * @private
* @type {Image|HTMLCanvasElement} * @type {HTMLImageElement|HTMLCanvasElement}
*/ */
this.image_ = !image ? new Image() : image; this.image_ = !image ? new Image() : image;
@@ -92,7 +92,7 @@ inherits(IconImage, EventTarget);
/** /**
* @param {Image|HTMLCanvasElement} image Image. * @param {HTMLImageElement|HTMLCanvasElement} image Image.
* @param {string} src Src. * @param {string} src Src.
* @param {module:ol/size~Size} size Size. * @param {module:ol/size~Size} size Size.
* @param {?string} crossOrigin Cross origin. * @param {?string} crossOrigin Cross origin.
@@ -161,7 +161,7 @@ IconImage.prototype.handleImageLoad_ = function() {
/** /**
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {Image|HTMLCanvasElement} Image or Canvas element. * @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
*/ */
IconImage.prototype.getImage = function(pixelRatio) { IconImage.prototype.getImage = function(pixelRatio) {
return this.canvas_ ? this.canvas_ : this.image_; return this.canvas_ ? this.canvas_ : this.image_;
@@ -178,7 +178,7 @@ IconImage.prototype.getImageState = function() {
/** /**
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {Image|HTMLCanvasElement} Image element. * @return {HTMLImageElement|HTMLCanvasElement} Image element.
*/ */
IconImage.prototype.getHitDetectionImage = function(pixelRatio) { IconImage.prototype.getHitDetectionImage = function(pixelRatio) {
if (!this.hitDetectionImage_) { if (!this.hitDetectionImage_) {

View File

@@ -122,7 +122,7 @@ ImageStyle.prototype.getAnchor = function() {};
* Get the image element for the symbolizer. * Get the image element for the symbolizer.
* @abstract * @abstract
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {HTMLCanvasElement|HTMLVideoElement|Image} Image element. * @return {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} Image element.
*/ */
ImageStyle.prototype.getImage = function(pixelRatio) {}; ImageStyle.prototype.getImage = function(pixelRatio) {};
@@ -130,7 +130,7 @@ ImageStyle.prototype.getImage = function(pixelRatio) {};
/** /**
* @abstract * @abstract
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @return {HTMLCanvasElement|HTMLVideoElement|Image} Image element. * @return {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} Image element.
*/ */
ImageStyle.prototype.getHitDetectionImage = function(pixelRatio) {}; ImageStyle.prototype.getHitDetectionImage = function(pixelRatio) {};