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.
Properties
Inherits properties from its parent, HTMLElement, and implements those from HTMLHyperlinkElementUtils.
HTMLAreaElement.accessKey- Is a
DOMStringcontaining a single character that switches input focus to the control. HTMLAreaElement.alt- Is a
DOMStringthat reflects thealtHTML attribute, containing alternative text for the element. HTMLAreaElement.coords- Is a
DOMStringthat reflects thecoordsHTML attribute, containing coordinates to define the hot-spot region. HTMLAreaElement.download- Is a
DOMStringindicating 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. HTMLHyperlinkElementUtils.hash- Is a
USVStringcontaining the fragment identifier (including the leading hash mark (#)), if any, in the referenced URL. HTMLHyperlinkElementUtils.host- Is a
USVStringcontaining the hostname and port (if it's not the default port) in the referenced URL. HTMLHyperlinkElementUtils.hostname- Is a
USVStringcontaining the hostname in the referenced URL. HTMLHyperlinkElementUtils.href- Is a
USVStringcontaining that reflects thehrefHTML attribute, containing a valid URL of a linked resource. HTMLAreaElement.hreflang- Is a
DOMStringcontaining that reflects thehreflangHTML attribute, indicating the language of the linked resource. HTMLAreaElement.media- Is a
DOMStringcontaining that reflects themediaHTML attribute, indicating target media of the linked resource. HTMLAreaElement.noHref- Is a
Booleanflag indicating if the area is inactive (true) or active (false). HTMLHyperlinkElementUtils.password- Is a
USVStringcontaining the password specified before the domain name. HTMLHyperlinkElementUtils.originRead only- Returns a
USVStringcontaining the origin of the URL, that is its scheme, its domain and its port. HTMLHyperlinkElementUtils.pathname- Is a
USVStringcontaining the path name component, if any, of the referenced URL. HTMLHyperlinkElementUtils.port- Is a
USVStringcontaining the port component, if any, of the referenced URL. HTMLHyperlinkElementUtils.protocol- Is a
USVStringcontaining the protocol component (including trailing colon':'), of the referenced URL. HTMLAreaElement.referrerPolicy- Is a
DOMStringthat reflects thereferrerpolicyHTML attribute indicating which referrer to use when fetching the linked resource. HTMLAreaElement.rel- Is a
DOMStringthat reflects therelHTML attribute, indicating relationships of the current document to the linked resource. HTMLAreaElement.relListRead only- Returns a
DOMTokenListthat reflects therelHTML attribute, indicating relationships of the current document to the linked resource, as a list of tokens. HTMLHyperlinkElementUtils.search- Is a
USVStringcontaining the search element (including leading question mark'?'), if any, of the referenced URL. HTMLAreaElement.shape- Is a
DOMStringthat reflects theshapeHTML attribute, indicating the shape of the hot-spot, limited to known values. HTMLAreaElement.tabIndex- Is a
longcontaining the element's position in the tabbing order. HTMLAreaElement.target- Is a
DOMStringthat reflects thetargetHTML attribute, indicating the browsing context in which to open the linked resource. HTMLAreaElement.type- Is a
DOMStringthat reflects thetypeHTML attribute, indicating the MIME type of the linked resource. HTMLHyperlinkElementUtils.username- Is a
USVStringcontaining the username specified before the domain name.
Methods
Inherits methods from its parent, HTMLElement and implement those from HTMLHyperlinkElementUtils.
HTMLHyperlinkElementUtils.toString()- Returns a
USVStringcontaining the whole URL of the script executed in theWorker. It is a synonym forURLUtils.href.
Specifications
| Specification | Status | Comment |
|---|---|---|
| Referrer Policy The definition of 'referrer attribute' in that specification. |
Working Draft | Added the referrerPolicy property. |
| WHATWG HTML Living Standard The definition of 'HTMLAreaElement' in that specification. |
Living Standard | The following property has been added: download.Technically, the URL-related properties, media, host, hostname, pathname, port, protocol, search, and hash, have been moving to the URLUtils interface, and HTMLAreaElement implements this interface. |
| HTML5 The definition of 'HTMLAreaElement' in that specification. |
Recommendation | Technically, the properties tabindex and accesskey are now defined on HTMLElement.The following property is now obsolete: nohref.The following properties have been added: rel, relList, media, hreflang, type, host, hostname, pathname, port, protocol, search, and hash. |
| Document Object Model (DOM) Level 2 HTML Specification The definition of 'HTMLAreaElement' in that specification. |
Recommendation | No change from Document Object Model (DOM) Level 1 Specification. |
| Document Object Model (DOM) Level 1 Specification The definition of 'HTMLAreaElement' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | (Yes) | 1.0 (1.7 or earlier) | (Yes) | (Yes) | (Yes) |
download |
? | ? | ? | ? | ? |
username, password, and origin |
? | 26.0 (26.0) | ? | ? | ? |
referrerPolicy |
Not supported | 42 (42) [1] | Not supported | Not supported | Not supported |
| Feature | Android | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|
| Basic support | (Yes) | 1.0 (1.0) | (Yes) | (Yes) | (Yes) |
download |
? | ? | ? | ? | ? |
username, password, and origin |
? | 26.0 (26.0) | ? | ? | ? |
referrerPolicy |
Not supported | 42.0 (42.0) [1] | Not supported | Not supported | Not supported |
[1] This property was named referrer from Firefox 42 to 44.
See also
- HTML element implementing this interface:
<area>.
