W3cubDocs

/Web APIs

HTMLAreaElement

The HTMLAreaElement interface provides special properties and methods (beyond those of the regular object HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of <area> elements.

EventTarget Node Element HTMLElement HTMLAreaElement

Instance properties

Inherits properties from its parent, HTMLElement.

HTMLElement.accessKey

A string containing a single character that switches input focus to the control.

HTMLAreaElement.alt

A string that reflects the alt HTML attribute, containing alternative text for the element.

HTMLAreaElement.coords

A string that reflects the coords HTML attribute, containing coordinates to define the hot-spot region.

HTMLAreaElement.download

A string indicating that the linked resource is intended to be downloaded rather than displayed in the browser. The value represent the proposed name of the file. If the name is not a valid filename of the underlying OS, browser will adapt it.

HTMLAreaElement.hash

A string containing the fragment identifier (including the leading hash mark (#)), if any, in the referenced URL.

HTMLAreaElement.host

A string containing the hostname and port (if it's not the default port) in the referenced URL.

HTMLAreaElement.hostname

A string containing the hostname in the referenced URL.

HTMLAreaElement.href

A string containing that reflects the href HTML attribute, containing a valid URL of a linked resource.

HTMLAreaElement.noHref Deprecated

A boolean flag indicating if the area is inactive (true) or active (false).

HTMLAreaElement.origin Read only

Returns a string containing the origin of the URL, that is its scheme, its domain and its port.

HTMLAreaElement.password

A string containing the password specified before the domain name.

HTMLAreaElement.pathname

A string containing the path name component, if any, of the referenced URL.

HTMLAreaElement.port

A string containing the port component, if any, of the referenced URL.

HTMLAreaElement.protocol

A string containing the protocol component (including trailing colon ':'), of the referenced URL.

HTMLAreaElement.referrerPolicy

A string that reflects the referrerpolicy HTML attribute indicating which referrer to use when fetching the linked resource.

HTMLAreaElement.rel

A string that reflects the rel HTML attribute, indicating relationships of the current document to the linked resource.

HTMLAreaElement.relList Read only

Returns a DOMTokenList that reflects the rel HTML attribute, indicating relationships of the current document to the linked resource, as a list of tokens.

HTMLAreaElement.search

A string containing the search element (including leading question mark '?'), if any, of the referenced URL.

HTMLAreaElement.shape

A string that reflects the shape HTML attribute, indicating the shape of the hot-spot, limited to known values.

HTMLElement.tabIndex

A long containing the element's position in the tabbing order.

HTMLAreaElement.target

A string that reflects the target HTML attribute, indicating the browsing context in which to open the linked resource.

HTMLAreaElement.username

A string containing the username specified before the domain name.

Instance methods

Inherits methods from its parent, HTMLElement.

HTMLAreaElement.toString()

Returns a string containing the whole URL. It is a synonym for HTMLAreaElement.href.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
HTMLAreaElement 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
alt 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
coords 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
download 54 13 20 No 41 10.1 54 54 20 41 10.3 6.0
hash 1 12
1From Firefox 29 to Firefox 40, the returned value was incorrectly percent-decoded.
5.5 15 1 4.4 18
4From Firefox 29 to Firefox 40, the returned value was incorrectly percent-decoded.
14 1 1.0
host 1 12 1
5.5In Internet Explorer 9, the host of an <a> always include the port (e.g. developer.mozilla.org:443), even if there is no explicit port in the href attribute value.
15 1 4.4 18 4 14 1 1.0
hostname 1 12 1 5.5 15 1 4.4 18 4 14 1 1.0
href 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
noHref 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
origin 32 17
26Before Firefox 49, results for URL using the blob scheme incorrectly returned null.
No 19 10 ≤37 32
26Before Firefox 49, results for URL using the blob scheme incorrectly returned null.
19 10 2.0
password 32 79 26 No 19 10 4.4.3 32 26 19 10 2.0
pathname 1 12
1Before Firefox 53, the pathname and search HTMLHyperlinkElementUtils properties returned the wrong parts of the URL. For example, for a URL of http://z.com/x?a=true&b=false, pathname would return '/x?a=true&b=false' and search would return '', rather than '/x' and '?a=true&b=false' respectively. This has now been fixed.
5.5 15 1 4.4 18
4Before Firefox 53, the pathname and search HTMLHyperlinkElementUtils properties returned the wrong parts of the URL. For example, for a URL of http://z.com/x?a=true&b=false, pathname would return '/x?a=true&b=false' and search would return '', rather than '/x' and '?a=true&b=false' respectively. This has now been fixed.
14 1 1.0
ping 12 17 1 No 15 5.1 ≤37 18 4 14 5 1.0
port 1 12 1 5.5 15 1 4.4 18 4 14 1 1.0
protocol 1 12 1 5.5 15 1 4.4 18 4 14 1 1.0
referrerPolicy 5251–52 79 50 No 3938–39 14.1 5251–52 5251–52 50 41 14.5 6.05.0–6.0
rel 54 12 30 11 41 9 54 54 30 41 9 6.0
relList 65 18 30 No 41 9 65 65 30 41 9 9.0
search 1 12
1Before Firefox 53, the pathname and search HTMLHyperlinkElementUtils properties returned the wrong parts of the URL. For example, for a URL of http://z.com/x?a=true&b=false, pathname would return '/x?a=true&b=false' and search would return '', rather than '/x' and '?a=true&b=false' respectively. This has now been fixed.
5.5 15 1 4.4 18
4Before Firefox 53, the pathname and search HTMLHyperlinkElementUtils properties returned the wrong parts of the URL. For example, for a URL of http://z.com/x?a=true&b=false, pathname would return '/x?a=true&b=false' and search would return '', rather than '/x' and '?a=true&b=false' respectively. This has now been fixed.
14 1 1.0
shape 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
target 1 12 1 5.5 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0
toString 32 12 22 5.5 19 10.1 4.4.3 32 22 19 10.3 2.0
username 32 79 26 No 19 10 4.4.3 32 26 19 10 2.0

See also

  • HTML element implementing this interface: <area>

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLAreaElement