View source

class ImageElement

package js.html

extends Element › DOMElement › Node › EventTarget

extended by Image

@:native("HTMLImageElement")

Available on js

The HTMLImageElement interface provides special properties and methods  for manipulating the layout and presentation of img elements.

Documentation HTMLImageElement by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Variables

align:String

Is a DOMString indicating the alignment of the image with respect to the surrounding context. The possible values are "left", "right", "justify", and "center".

alt:String

Is a DOMString that reflects the alt HTML attribute,  thus indicating fallback context for the image.

border:String

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.

read onlycomplete:Bool

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 HTMLImageElement.src value.

crossOrigin:String

Is a DOMString representing the CORS setting for this image element. See CORS settings attributes for further details.

read onlycurrentSrc:String

Returns a DOMString representing the URL to the currently displayed image (which may change, for example in response to media queries).

decoding:String

Returns a DOMString representing a hint given to the browser on how it should decode the image.

height:Int

Is a unsigned long that reflects the height HTML attribute, indicating the rendered height of the image in CSS pixels.

hspace:Int

Is a long representing the space on either side of the image.

isMap:Bool

Is a Boolean that reflects the ismap HTML attribute, indicating that the image is part of a server-side image map.

longDesc:String

Is a DOMString representing the URI of a long description of the image.

lowsrc:String

Is a DOMString that refers to a low-quality (but faster to load) copy of the image.

name:String

Is a DOMString representing the name of the element.

read onlynaturalHeight:Int

Returns a unsigned long representing the intrinsic height of the image in CSS pixels, if it is available; else, it shows 0.

read onlynaturalWidth:Int

Returns a unsigned long representing the intrinsic width of the image in CSS pixels, if it is available; otherwise, it will show 0.

referrerPolicy:String

Is a DOMString that reflects the referrerpolicy HTML attribute indicating which referrer to use in order to fetch the image.

sizes:String

Is a DOMString reflecting the sizes HTML attribute.

src:String

Is a DOMString that reflects the src HTML attribute, containing the full URL of the image including base URI.

srcset:String

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.

useMap:String

Is a DOMString that reflects the usemap HTML attribute, containing a partial URL of a map element.

vspace:Int

Is a long representing the space above and below the image.

width:Int

Is a unsigned long that reflects the width HTML attribute, indicating the rendered width of the image in CSS pixels.

read onlyx:Int

Returns a long representing the horizontal offset from the nearest layer. This property mimics an old Netscape 4 behavior.

read onlyy:Int

Returns a long representing the vertical offset from the nearest layer. This property is also similar to behavior of an old Netscape 4.

Inherited Variables

Defined by DOMElement

accessKey:String

read onlyaccessKeyLabel:String

read onlyassignedSlot:SlotElement

read onlyattributes:NamedNodeMap

Returns a NamedNodeMap object containing the assigned attributes of the corresponding HTML element.

read onlychildElementCount:Int

read onlychildren:HTMLCollection

read onlyclassList:DOMTokenList

Returns a DOMTokenList containing the list of class attributes.

className:String

Is a DOMString representing the class of the element.

read onlyclientHeight:Int

Returns a Number representing the inner height of the element.

read onlyclientLeft:Int

Returns a Number representing the width of the left border of the element.

read onlyclientTop:Int

Returns a Number representing the width of the top border of the element.

read onlyclientWidth:Int

Returns a Number representing the inner width of the element.

contentEditable:String

read onlycontextMenu:MenuElement

read onlydataset:DOMStringMap

dir:String

draggable:Bool

read onlyfirstElementChild:Element

hidden:Bool

id:String

Is a DOMString representing the id of the element.

innerHTML:String

Is a DOMString representing the markup of the element's content.

innerText:String

read onlyisContentEditable:Bool

itemId:String

read onlyitemProp:DOMTokenList

read onlyitemRef:DOMTokenList

itemScope:Bool

read onlyitemType:DOMTokenList

itemValue:Dynamic

lang:String

read onlylastElementChild:Element

read onlylocalName:String

A DOMString representing the local part of the qualified name of the element.

read onlynamespaceURI:String

The namespace URI of the element, or null if it is no namespace.

Note: In Firefox 3.5 and earlier, HTML elements are in no namespace. In later versions, HTML elements are in the http://www.w3.org/1999/xhtml namespace in both HTML and XML trees. 1.9.2

read onlynextElementSibling:Element

read onlyoffsetHeight:Int

read onlyoffsetLeft:Int

read onlyoffsetParent:Element

read onlyoffsetTop:Int

read onlyoffsetWidth:Int

onabort:Function

onanimationcancel:Function

onanimationend:Function

onanimationiteration:Function

onanimationstart:Function

onauxclick:Function

onblur:Function

oncanplay:Function

oncanplaythrough:Function

onchange:Function

onclick:Function

onclose:Function

oncontextmenu:Function

oncopy:Function

oncut:Function

ondblclick:Function

ondrag:Function

ondragend:Function

ondragenter:Function

ondragexit:Function

ondragleave:Function

ondragover:Function

ondragstart:Function

ondrop:Function

ondurationchange:Function

onemptied:Function

onended:Function

onerror:Function

onfocus:Function

ongotpointercapture:Function

Returns the event handler for the gotpointercapture event type.

oninput:Function

oninvalid:Function

onkeydown:Function

onkeypress:Function

onkeyup:Function

onload:Function

onloadeddata:Function

onloadedmetadata:Function

onloadend:Function

onloadstart:Function

onlostpointercapture:Function

Returns the event handler for the lostpointercapture event type.

onmousedown:Function

onmouseenter:Function

onmouseleave:Function

onmousemove:Function

onmouseout:Function

onmouseover:Function

onmouseup:Function

onpaste:Function

onpause:Function

onplay:Function

onplaying:Function

onpointercancel:Function

onpointerdown:Function

onpointerenter:Function

onpointerleave:Function

onpointermove:Function

onpointerout:Function

onpointerover:Function

onpointerup:Function

onprogress:Function

onratechange:Function

onreset:Function

onresize:Function

onscroll:Function

onseeked:Function

onseeking:Function

onselect:Function

onselectstart:Function

onshow:Function

onstalled:Function

onsubmit:Function

onsuspend:Function

ontimeupdate:Function

ontoggle:Function

ontouchcancel:Function

ontouchend:Function

ontouchmove:Function

ontouchstart:Function

ontransitioncancel:Function

ontransitionend:Function

ontransitionrun:Function

ontransitionstart:Function

onvolumechange:Function

onwaiting:Function

onwebkitanimationend:Function

onwebkitanimationiteration:Function

onwebkitanimationstart:Function

onwebkittransitionend:Function

onwheel:Function

Returns the event handling code for the wheel event. This is now implemented on GlobalEventHandlers.onwheel.

outerHTML:String

Is a DOMString representing the markup of the element including its content. When used as a setter, replaces the element with nodes parsed from the given string.

read onlyprefix:String

A DOMString representing the namespace prefix of the element, or null if no prefix is specified.

read onlypreviousElementSibling:Element

read onlyproperties:HTMLPropertiesCollection

read onlyscrollHeight:Int

Returns a Number representing the scroll view height of an element.

scrollLeft:Int

Is a Number representing the left scroll offset of the element.

read onlyscrollLeftMax:Int

Returns a Number representing the maximum left scroll offset possible for the element.

scrollTop:Int

A Number representing number of pixels the top of the document is scrolled vertically.

read onlyscrollTopMax:Int

Returns a Number representing the maximum top scroll offset possible for the element.

read onlyscrollWidth:Int

Returns a Number representing the scroll view width of the element.

read onlyshadowRoot:ShadowRoot

Returns the open shadow root that is hosted by the element, or null if no open shadow root is present.

slot:String

Returns the name of the shadow DOM slot the element is inserted in.

spellcheck:Bool

read onlystyle:CSSStyleDeclaration

tabIndex:Int

read onlytagName:String

Returns a String with the name of the tag for the given element.

title:String

Defined by Node

read onlybaseURI:String

Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.

read onlychildNodes:NodeList

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

read onlyfirstChild:Node

Returns a Node representing the first direct child node of the node, or null if the node has no child.

read onlyisConnected:Bool

Returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.

read onlylastChild:Node

Returns a Node representing the last direct child node of the node, or null if the node has no child.

read onlynextSibling:Node

Returns a Node representing the next node in the tree, or null if there isn't such node.

read onlynodeName:String

Returns a DOMString containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

read onlynodeType:Int

Returns an unsigned short representing the type of the node. Possible values are:

Name Value

ELEMENT_NODE 1
ATTRIBUTE_NODE (deprecated) 2
TEXT_NODE 3
CDATA_SECTION_NODE (deprecated) 4
ENTITY_REFERENCE_NODE (deprecated) 5
ENTITY_NODE (deprecated) 6
PROCESSING_INSTRUCTION_NODE 7
COMMENT_NODE 8
DOCUMENT_NODE 9
DOCUMENT_TYPE_NODE 10
DOCUMENT_FRAGMENT_NODE 11
NOTATION_NODE (deprecated) 12

nodeValue:String

Returns / Sets the value of the current node

read onlyownerDocument:HTMLDocument

Returns the Document that this node belongs to. If the node is itself a document, returns null.

read onlyparentElement:Element

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

read onlyparentNode:Node

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

read onlypreviousSibling:Node

Returns a Node representing the previous node in the tree, or null if there isn't such node.

textContent:String

Returns / Sets the textual content of an element and all its descendants.

Inherited Methods

Defined by Element

blur():Void

Removes keyboard focus from the currently focused element.

Throws:

null

DOMError

click():Void

Sends a mouse click event to the element.

focus():Void

Makes the element the current keyboard focus.

Throws:

null

DOMError

Defined by DOMElement

after(nodes:Rest<Node>):Void

after(nodes:Rest<String>):Void

Throws:

null

DOMError

animate(keyframes:Dynamic, ?options:Float):Animation

animate(keyframes:Dynamic, ?options:KeyframeAnimationOptions):Animation

A shortcut method to create and run an animation on an element. Returns the created Animation object instance.

Throws:

null

DOMError

append(nodes:Rest<Node>):Void

append(nodes:Rest<String>):Void

Throws:

null

DOMError

attachShadow(shadowRootInitDict:ShadowRootInit):ShadowRoot

Attatches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.

Throws:

null

DOMError

before(nodes:Rest<Node>):Void

before(nodes:Rest<String>):Void

Throws:

null

DOMError

closest(selector:String):Element

Returns the Element which is the closest ancestor of the current element (or the current element itself) which matches the selectors given in parameter.

Throws:

null

DOMError

convertPointFromNode(point:DOMPointInit, from:Text, ?options:ConvertCoordinateOptions):DOMPoint

convertPointFromNode(point:DOMPointInit, from:Element, ?options:ConvertCoordinateOptions):DOMPoint

convertPointFromNode(point:DOMPointInit, from:HTMLDocument, ?options:ConvertCoordinateOptions):DOMPoint

Throws:

null

DOMError

convertQuadFromNode(quad:DOMQuad, from:Text, ?options:ConvertCoordinateOptions):DOMQuad

convertQuadFromNode(quad:DOMQuad, from:Element, ?options:ConvertCoordinateOptions):DOMQuad

convertQuadFromNode(quad:DOMQuad, from:HTMLDocument, ?options:ConvertCoordinateOptions):DOMQuad

Throws:

null

DOMError

convertRectFromNode(rect:DOMRectReadOnly, from:Text, ?options:ConvertCoordinateOptions):DOMQuad

convertRectFromNode(rect:DOMRectReadOnly, from:Element, ?options:ConvertCoordinateOptions):DOMQuad

convertRectFromNode(rect:DOMRectReadOnly, from:HTMLDocument, ?options:ConvertCoordinateOptions):DOMQuad

Throws:

null

DOMError

getAnimations(?filter:AnimationFilter):Array<Animation>

Returns an array of Animation objects currently active on the element.

getAttribute(name:String):String

Retrieves the value of the named attribute from the current node and returns it as an Object.

getAttributeNS(namespace:String, localName:String):String

Retrieves the value of the attribute with the specified name and namespace, from the current node and returns it as an Object.

getAttributeNames():Array<String>

Returns an array of attribute names from the current element.

getAttributeNode(name:String):Attr

Retrieves the node representation of the named attribute from the current node and returns it as an Attr.

getAttributeNodeNS(namespaceURI:String, localName:String):Attr

Retrieves the node representation of the attribute with the specified name and namespace, from the current node and returns it as an Attr.

getBoundingClientRect():DOMRect

Returns the size of an element and its position relative to the viewport.

getClientRects():DOMRectList

Returns a collection of rectangles that indicate the bounding rectangles for each line of text in a client.

getElementsByClassName(classNames:String):HTMLCollection

Returns a live HTMLCollection that contains all descendants of the current element that possess the list of classes given in the parameter.

getElementsByTagName(localName:String):HTMLCollection

Returns a live HTMLCollection containing all descendant elements, of a particular tag name, from the current element.

getElementsByTagNameNS(namespace:String, localName:String):HTMLCollection

Returns a live HTMLCollection containing all descendant elements, of a particular tag name and namespace, from the current element.

Throws:

null

DOMError

hasAttribute(name:String):Bool

Returns a Boolean indicating if the element has the specified attribute or not.

hasAttributeNS(namespace:String, localName:String):Bool

Returns a Boolean indicating if the element has the specified attribute, in the specified namespace, or not.

hasAttributes():Bool

Returns a Boolean indicating if the element has one or more HTML attributes present.

hasPointerCapture(pointerId:Int):Bool

insertAdjacentElement(where:String, element:Element):Element

Inserts a given element node at a given position relative to the element it is invoked upon.

Throws:

null

DOMError

insertAdjacentHTML(position:String, text:String):Void

Parses the text as HTML or XML and inserts the resulting nodes into the tree in the position given.

Throws:

null

DOMError

insertAdjacentText(where:String, data:String):Void

Inserts a given text node at a given position relative to the element it is invoked upon.

Throws:

null

DOMError

matches(selector:String):Bool

Returns a Boolean indicating whether or not the element would be selected by the specified selector string.

Throws:

null

DOMError

prepend(nodes:Rest<Node>):Void

prepend(nodes:Rest<String>):Void

Throws:

null

DOMError

querySelector(selectors:String):Element

Returns the first Node which matches the specified selector string relative to the element.

Throws:

null

DOMError

querySelectorAll(selectors:String):NodeList

Returns a NodeList of nodes which match the specified selector string relative to the element.

Throws:

null

DOMError

releaseCapture():Void

releasePointerCapture(pointerId:Int):Void

Releases (stops) pointer capture that was previously set for a specific PointerEvent.

Throws:

null

DOMError

remove():Void

removeAttribute(name:String):Void

Removes the named attribute from the current node.

Throws:

null

DOMError

removeAttributeNS(namespace:String, localName:String):Void

Removes the attribute with the specified name and namespace, from the current node.

Throws:

null

DOMError

removeAttributeNode(oldAttr:Attr):Attr

Removes the node representation of the named attribute from the current node.

Throws:

null

DOMError

replaceWith(nodes:Rest<Node>):Void

replaceWith(nodes:Rest<String>):Void

Throws:

null

DOMError

requestFullscreen(?options:FullscreenOptions):Promise<Void>

Asynchronously asks the browser to make the element full-screen.

Throws:

null

DOMError

requestPointerLock():Void

Allows to asynchronously ask for the pointer to be locked on the given element.

scroll(?options:ScrollToOptions):Void

scroll(x:Float, y:Float):Void

scrollBy(?options:ScrollToOptions):Void

scrollBy(x:Float, y:Float):Void

scrollIntoView(?arg:Bool):Void

scrollIntoView(?arg:ScrollIntoViewOptions):Void

Scrolls the page until the element gets into the view.

scrollTo(?options:ScrollToOptions):Void

scrollTo(x:Float, y:Float):Void

setAttribute(name:String, value:String):Void

Sets the value of a named attribute of the current node.

Throws:

null

DOMError

setAttributeNS(namespace:String, name:String, value:String):Void

Sets the value of the attribute with the specified name and namespace, from the current node.

Throws:

null

DOMError

setAttributeNode(newAttr:Attr):Attr

Sets the node representation of the named attribute from the current node.

Throws:

null

DOMError

setAttributeNodeNS(newAttr:Attr):Attr

Sets the node representation of the attribute with the specified name and namespace, from the current node.

Throws:

null

DOMError

@:value({ retargetToElement : false })setCapture(retargetToElement:Bool = false):Void

Sets up mouse event capture, redirecting all mouse events to this element.

setPointerCapture(pointerId:Int):Void

Designates a specific element as the capture target of future pointer events.

Throws:

null

DOMError

toggleAttribute(name:String, ?force:Bool):Bool

Toggles a boolean attribute, removing it if it is present and adding it if it is not present, on the specified element.

Throws:

null

DOMError

webkitMatchesSelector(selector:String):Bool

Throws:

null

DOMError

Defined by Node

appendChild(node:Node):Node

Adds the specified childNode argument as the last child to the current node.

If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.

	@throws DOMError

@:value({ deep : false })cloneNode(deep:Bool = false):Node

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Throws:

null

DOMError

compareDocumentPosition(other:Node):Int

Compares the position of the current node against another node in any other document.

contains(other:Node):Bool

Returns a Boolean value indicating whether a node is a descendant of a given node or not.

getRootNode(?options:GetRootNodeOptions):Node

Returns the context object's root which optionally includes the shadow root if it is available. 

hasChildNodes():Bool

Returns a Boolean indicating if the element has any child nodes, or not.

insertBefore(node:Node, child:Node):Node

Inserts a Node before the reference node as a child of a specified parent node.

Throws:

null

DOMError

isDefaultNamespace(namespace:String):Bool

Accepts a namespace URI as an argument and returns a Boolean with a value of true if the namespace is the default namespace on the given node or false if not.

isEqualNode(node:Node):Bool

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

isSameNode(node:Node):Bool

Returns a Boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).

lookupNamespaceURI(prefix:String):String

Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

lookupPrefix(namespace:String):String

Returns a DOMString containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

normalize():Void

Clean up all the text nodes under this element (merge adjacent, remove empty).

removeChild(child:Node):Node

Removes a child node from the current element, which must be a child of the current node.

Throws:

null

DOMError

replaceChild(node:Node, child:Node):Node

Replaces one child Node of the current one with the second one given in parameter.

Throws:

null

DOMError

Defined by EventTarget

addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

Register an event handler of a specific event type on the EventTarget.

Throws:

null

DOMError

dispatchEvent(event:Event):Bool

Dispatch an event to this EventTarget.

Throws:

null

DOMError

removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void

removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void

Removes an event listener from the EventTarget.

Throws:

null

DOMError