HTMLImageElement

HTMLImageElement 介面提供了特殊的屬性及方法以用來操作 <img> 元素的畫面佈局與外觀呈現。

屬性

Inherits properties from its parent, HTMLElement.

HTMLImageElement.align
Is a DOMString indicating the alignment of the image with respect to the surrounding context.
HTMLImageElement.alt
Is a DOMString that reflects the alt HTML attribute,  thus indicating fallback context for the image.
HTMLImageElement.border
Is a DOMString that is responsible for the width of the border surrounding the image. This is now deprecated and the CSS border property should be used instead.
HTMLImageElement.complete Read only
Returns a Boolean that is true if the browser has finished fetching the image, whether successful or not. It also shows true, if the image has no src value.
HTMLImageElement.crossOrigin
Is a DOMString representing the CORS setting for this image element. See CORS settings attributes for further details.
HTMLImageElement.currentSrc Read only
Returns a DOMString representing the URL to the currently displayed image (which may change, for example in response to media queries).
HTMLImageElement.height
一個反映了 HTML img 元素之 height 屬性的無符號（unsigned）整數，表示圖片經渲染後的高度（CSS pixels）。
HTMLImageElement.hspace
Is a long representing the space on either side of the image.
HTMLImageElement.isMap
Is a Boolean that reflects the ismap HTML attribute, indicating that the image is part of a server-side image map.
HTMLImageElement.longDesc
Is a DOMString representing the URI of a long description of the image.
HTMLImageElement.lowSrc
Is a DOMString that refers to a low-quality (but faster to load) copy of the image.
HTMLImageElement.name
Is a DOMString representing the name of the element.
HTMLImageElement.naturalHeight Read only
回傳一個代表圖片固有高度（CSS pixels）的無符號（unsigned）整數，如果無法取得則回傳 0。
HTMLImageElement.naturalWidth Read only
回傳一個代表圖片固有寬度（CSS pixels）的無符號（unsigned）整數，如果無法取得則回傳 0。
HTMLImageElement.referrerPolicy
Is a DOMString that reflects the referrerpolicy HTML attribute indicating which referrer to use in order to fetch the image.
HTMLImageElement.src
Is a DOMString that reflects the src HTML attribute, containing the full URL of the image including base URI.
HTMLImageElement.sizes
Is a DOMString reflecting the sizes HTML attribute.
HTMLImageElement.srcset
Is a DOMString reflecting the srcset HTML attribute, containing a list of candidate images, separated by a comma (',', U+002C COMMA). A candidate image is a URL followed by a 'w' with the width of the images, or an 'x' followed by the pixel density.
HTMLImageElement.useMap
Is a DOMString that reflects the usemap HTML attribute, containing a partial URL of a map element.
HTMLImageElement.vspace
Is a long representing the space above and below the image.
HTMLImageElement.width
一個反映了 HTML img 元素之 width 屬性的無符號（unsigned）整數，表示圖片經渲染後的寬度（CSS pixels）。
HTMLImageElement.x Read only
Returns a long representing the horizontal offset from the nearest layer. This property mimics an old Netscape 4 behavior.
HTMLImageElement.y Read only
Returns a long representing the vertical offset from the nearest layer. This property is also similar to behavior of an old Netscape 4.

方法

Inherits properties from its parent, HTMLElement.

Image()
The Image() constructor, taking two optional unsigned long, which are the width and the height of the resource, creates an instance of HTMLImageElement , not inserted in a DOM tree.

Errors

If an error occurs while trying to load or render the image, and an onerror event handler has been configured to handle the error event, that event handler will get called. This can happen in a number of situations, including:

  • The src attribute is empty or null.
  • The specified src URL is the same as the URL of the page the user is currently on.
  • The specified image is corrupted in some way that prevents it from being loaded.
  • The specified image's metadata is corrupted in such a way that it's impossible to retrieve its dimensions, and no dimensions were specified in the <img> element's attributes.
  • The specified image is in a format not supported by the user agent.

範例

var img1 = new Image(); // HTML5 Constructor
img1.src = 'image1.png';
img1.alt = 'alt';
document.body.appendChild(img1);

var img2 = document.createElement('img'); // use DOM HTMLImageElement
img2.src = 'image2.jpg';
img2.alt = 'alt text';
document.body.appendChild(img2);

// using first image in the document
alert(document.images[0].src);

規範

Specification Status Comment
Referrer Policy
The definition of 'referrer attribute' in that specification.		 Candidate Recommendation Added the referrerPolicy property.
CSS Object Model (CSSOM) View Module
The definition of 'Extensions to HTMLImageElement' in that specification.		 Working Draft Added the x and y properties.
HTML Living Standard
The definition of 'HTMLImageElement' in that specification.		 Living Standard The following properties have been added: srcset, currentSrc and sizes.
HTML5
The definition of 'HTMLImageElement' in that specification.		 Recommendation A constructor (with 2 optional parameters) has been added.
The following properties are now obsolete: name, border, align, hspace, vspace, and longdesc.
The following properties are now unsigned long, instead of long: height, and width.
The following properties have been added: crossorigin, naturalWidth, naturalHeight, and complete.
Document Object Model (DOM) Level 2 HTML Specification
The definition of 'HTMLImgElement' in that specification.		 Obsolete The lowSrc property has been removed.
The following properties are now long, instead of DOMString: height, width, hspace, and vspace.
Document Object Model (DOM) Level 1 Specification
The definition of 'HTMLImgElement' in that specification.		 Obsolete Initial definition.

瀏覽器相容性

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!
Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) 1.0 (1.7 or earlier) (Yes) (Yes) (Yes)
lowSrc (Yes) (Yes) (Yes) ? (Yes) (Yes)
naturalWidth, naturalHeight (Yes) (Yes) (Yes) 9 (Yes) (Yes)
crossorigin (Yes) (Yes) (Yes) 9 (Yes) (Yes)
complete (Yes) (Yes) (Yes) 5[4] (Yes) (Yes)
srcset 34 (Yes) 32 (32)[2] No support 21 7.1
currentSrc (Yes) (Yes) 32 (32)[2] No support (Yes) No support
sizes (Yes) (Yes) 33 (33)[3] No support (Yes) No support
x and y (Yes) (Yes) 14[1] No support (Yes) (Yes)
referrerPolicy 51 No support 50 (50) No support No support No support
onerror event handler No support ? 51 (51)[5] No support (Yes) (Yes)
Feature Android Webview Chrome for Android Edge Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) 1.0 (1.0) (Yes) (Yes) (Yes)
lowSrc (Yes) (Yes) (Yes) ? ? ? ?
naturalWidth, naturalHeight (Yes) (Yes) (Yes) ? 9 ? (Yes)
crossorigin (Yes) (Yes) (Yes) (Yes) ? ? (Yes)
complete (Yes) (Yes) (Yes) (Yes) ? ? (Yes)
srcset 34 34 (Yes) 32.0 (32)[2] No support No support iOS 8
currentSrc (Yes) (Yes) (Yes) 32.0 (32)[2] No support No support No support
sizes (Yes) (Yes) (Yes) 33.0 (33)[3] No support No support No support
x and y (Yes) (Yes) (Yes) 14[1] No support (Yes) (Yes)
referrerPolicy 51 51 No support 50.0 (50) No support No support No support
onerror event handler No support No support ? 51.0 (51) No support (Yes) (Yes)

[1] Though, these x and y properties were removed in Gecko 7.0 (Firefox 7.0 / Thunderbird 7.0 / SeaMonkey 2.4) but later, they were restored in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11) for compatibility reasons.

[2] This feature is behind the dom.image.srcset.enabled preference, defaulting to false.

[3] This feature is behind the dom.image.picture.enabled preference, defaulting to false.

[4] IE reports false for broken images.

[5] May also be supported in earlier versions.

See also

  • The HTML element implementing this interface: <img>