Deutsch | English | Español | Français |
Italiano | 日本語 | 한국어 | Português |
Pусский | 简体中文 | 繁體中文 |
Defines the shape, coordinates, and associated URL of one hyperlink region within a client-side image map.
![]() ![]() |
HTML information
Closing Tag | forbidden |
---|---|
CSS Display |
DOM Information
Inheritance Hierarchy
Members
The area object has these types of members:
Events
The area object has these events.
Event | Description |
---|---|
click |
Fires when the user clicks the left mouse button on the object. Note Starting with IE11, this event fires a
MSPointerEvent object instead of
MouseEvent. You can use the MouseEvent.
pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
abort |
Fires when the user aborts the download. |
activate |
Fires when the object is set as the active element. |
afterupdate |
Fires on a databound object after successfully updating the associated data in the data source object. |
beforeactivate |
Fires immediately before the object is set as the active element. |
beforecopy |
Fires on the source object before the selection is copied to the system clipboard. |
beforecut |
Fires on the source object before the selection is deleted from the document. |
beforeeditfocus |
Fires before an object contained in an editable element enters a UI Activation state or when an editable container object is control selection. |
beforepaste |
Fires on the target object before the selection is pasted from the system clipboard to the document. |
beforeupdate |
Fires on a databound object before updating the associated data in the data source object. |
blur |
Fires when the object loses the input focus. |
cellchange |
Fires when data changes in the data provider. |
change |
Fires when the contents of the object or selection have changed. |
contextmenu |
Fires when the user clicks the right mouse button in the client area, opening the context menu. Note Starting with IE11, this event fires a
MSPointerEvent object instead of
MouseEvent. You can use the MouseEvent.
pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
controlselect |
Fires when the user is about to make a control selection of the object. |
cut |
Fires on the source element when the object or selection is removed from the document and added to the system clipboard. |
dataavailable |
Fires periodically as data arrives from data source objects that asynchronously transmit their data. |
datasetchanged |
Fires when the data set exposed by a data source object changes. |
dblclick |
Fires when the user double-clicks the object. Note Starting with IE11, this event fires a
MSPointerEvent object instead of a
MouseEvent. You can use the MouseEvent.
pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
deactivate |
Fires when the activeElement is changed from the current object to another object in the parent document. |
drag |
Fires on the source object continuously during a drag operation. |
dragend |
Fires on the source object when the user releases the mouse at the close of a drag operation. |
dragenter |
Fires on the target element when the user drags the object to a valid drop target. |
dragleave |
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. |
dragover |
Fires on the target element continuously while the user drags the object over a valid drop target. |
dragstart |
Fires on the source object when the user starts to drag a text selection or selected object. |
drop |
Fires on the target object when the mouse button is released during a drag-and-drop operation. |
error |
Fires when an error occurs during object loading. |
errorupdate |
Fires on a databound object when an error occurs while updating the associated data in the data source object. |
filterchange |
Fires when a visual filter changes state or completes a transition. |
focus |
Fires when the object receives focus. |
focusin |
Fires for an element just prior to setting focus on that element. |
focusout |
Fires for the current element with focus immediately after moving focus to another element. |
help |
Fires when the user presses the F1 key while the client is the active window. |
input |
Occurs when the text content of an element is changed through the user interface. |
keydown |
Fires when the user presses a key. |
keypress |
Fires when the user presses an alphanumeric key. |
layoutcomplete |
Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document. |
load |
Fires immediately after the client loads the object. |
losecapture |
Fires when the object loses the mouse capture. |
mousedown |
Fires when the user clicks the object with either mouse button. |
mouseenter |
Fires when the user moves the mouse pointer into the object. |
mouseleave |
Fires when the user moves the mouse pointer outside the boundaries of the object. |
mousemove |
Fires when the user moves the mouse over the object. |
mouseout |
Fires when the user moves the mouse pointer outside the boundaries of the object. |
mouseover |
Fires when the user moves the mouse pointer into the object. |
mouseup |
Fires when the user releases a mouse button while the mouse is over the object. |
mousewheel |
Fires when the wheel button is rotated. |
move |
Fires when the object moves. |
moveend |
Fires when the object stops moving. |
movestart |
Fires when the object starts to move. |
onbeforedeactivate |
Fires immediately before the activeElement is changed from the current object to another object in the parent document. |
ondatasetcomplete |
Fires to indicate that all data is available from the data source object. |
onkeyup |
Fires when the user releases a key. |
onselect |
Fires when the current selection changes. |
paste |
Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document. |
propertychange |
Fires when a property changes on the object. Note The
onpropertychange event is only supported in conjunction with the legacy
attachEvent IE-only event registration model, which has
deprecated since Internet Explorer 9 in favor of the W3C standard "
addEventListener" event model.
|
readystatechange |
Fires when the state of the object has changed. |
reset |
Fires when the user resets a form. |
resize |
Fires when the size of the object is about to change. |
resizeend |
Fires when the user finishes changing the dimensions of the object in a control selection. |
resizestart |
Fires when the user begins to change the dimensions of the object in a control selection. |
rowenter |
Fires to indicate that the current row has changed in the data source and new data values are available on the object. |
rowexit |
Fires just before the data source control changes the current row in the object. |
rowsdelete |
Fires when rows are about to be deleted from the recordset. |
rowsinserted |
Fires just after new rows are inserted in the current recordset. |
scroll |
Fires when the user repositions the scroll box in the scroll bar on the object. |
selectstart |
Fires when the object is being selected. |
Methods
The area object has these methods.
Method | Description |
---|---|
addBehavior |
Attaches a behavior to the element. |
applyElement |
Makes the element either a child or parent of another element. |
attachEvent |
Note
attachEvent is no longer supported. Starting with IE11, use
addEventListener. For info, see
Compatibility changes.
Binds the specified function to an event, so that the function gets called whenever the event fires on the object. |
blur |
Causes the element to lose focus and fires the onblur event. |
clearAttributes |
Removes all attributes and values from the object. |
click |
Simulates a click by causing the onclick event to fire. |
cloneNode |
Copies a reference to the object from the document hierarchy. |
componentFromPoint |
Returns the component located at the specified coordinates via certain events. |
contains |
Checks whether the given element is contained within the object. |
detachEvent |
Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires. |
doScroll |
Note
doScroll is no longer supported. Starting with IE11, use
scrollLeft or
scrollTop. For info, see
Compatibility changes.
Simulates a click on a scroll bar component. |
dragDrop |
Initiates a drag event. |
fireEvent |
Fires a specified event on the object. |
focus |
Causes the element to receive the focus and executes the code specified by the onfocus event. |
getAdjacentText |
Returns the adjacent text string. |
getAttribute |
Retrieves the value of the specified attribute. |
getAttributeNode |
Retrieves an attribute object referenced by the attribute. name property. |
getAttributeNodeNS |
Gets an attribute object that matches the specified namespace and name. |
getAttributeNS |
Gets the value of the specified attribute within the specified namespace. |
getBoundingClientRect |
Retrieves an object that specifies the bounds of a collection of TextRectangle objects. |
getClientRects |
Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client. Each rectangle describes a single line. |
getElementsByClassName |
Gets a collection of objects that are based on the value of the class attribute. |
getElementsByTagName |
Retrieves a collection of objects based on the specified element name. |
getElementsByTagNameNS |
Gets a collection of objects that are based on the specified element names within a specified namespace. |
hasAttribute |
Determines whether an attribute with the specified name exists. |
hasAttributeNS |
Determines whether an attribute that has the specified namespace and name exists. |
hasAttributes |
Determines whether one or more attributes exist for the object. |
hasChildNodes |
Returns a value that indicates whether the object has children. |
insertAdjacentElement |
Inserts an element at the specified location. |
insertAdjacentHTML |
Inserts the given HTML text into the element at the location. |
insertAdjacentText |
Inserts the given text into the element at the specified location. |
mergeAttributes |
Copies all read/write attributes to the specified element. |
msMatchesSelector |
Determines whether an object matches the specified selector. |
normalize |
Merges adjacent DOM objects to produce a normalized document object model. |
releaseCapture |
Removes mouse capture from the object in the current document. |
removeAttribute |
Removes an attribute from an object. |
removeAttributeNode |
Removes an attribute object from the object. |
removeAttributeNS |
Removes the specified attribute from the object. |
removeBehavior |
Detaches a behavior from the element. |
removeNode |
Removes the object from the document hierarchy. |
replaceAdjacentText |
Replaces the text adjacent to the element. |
replaceNode |
Replaces the object with another element. |
scrollIntoView |
Causes the object to scroll into view, aligning it either at the top or bottom of the window. |
setActive |
Sets the object as active without setting focus to the object. |
setAttribute |
Sets the value of the specified attribute. |
setAttributeNode |
Sets an attribute object node as part of the object. |
setAttributeNodeNS |
Sets an attribute object as part of the object. |
setAttributeNS |
Sets the value of the specified attribute within the specified namespace. |
setCapture |
Sets the mouse capture to the object that belongs to the current document. |
swapNode |
Exchanges the location of two objects in the document hierarchy. |
Properties
The area object has these properties.
Property | Description |
---|---|
Sets or retrieves the access key for the object. | |
Sets or retrieves a text alternative to the graphic. | |
Specifies whether the element and its contents must be selected as a whole, indivisible unit. | |
Retrieves a collection of attributes of the object. | |
Gets a value indicating whether the object can contain child objects. | |
Retrieves the value indicating whether the object can contain rich HTML markup. | |
Retrieves the number of immediate child nodes of the current element or a zero if the element does not contain any child nodes. childElementCount does not return all child nodes, only child nodes that are nodeType =1, or element nodes. | |
Sets or retrieves the class of the object. | |
Returns a reference to the constructor of an object. | |
Sets or retrieves the coordinates of the object. | |
Sets or retrieves the reading order of the object. | |
Gets a reference to the first child in the childNodes collection of the object. | |
Retrieves a reference to the first child element, or NULL if there are no child elements. | |
Sets or retrieves the subsection of the href property that follows the number sign (#). | |
Sets or gets the value that indicates whether the object visibly shows that it has focus. | |
Sets or retrieves the hostname and port number of the location or URL. | |
Sets or retrieves the host name part of the location or URL. | |
Sets or retrieves a destination URL or an anchor point. | |
Sets or retrieves the string identifying the object. | |
Sets or retrieves the HTML between the start and end tags of the object. | |
Sets or retrieves the text between the start and end tags of the object. | |
Gets the value that indicates whether the user can edit the contents of the object. | |
Gets the value that indicates whether the user can interact with the object. | |
Retrieves the value indicating whether the content of the object contains one or more lines. | |
Retrieves whether a TextRange object can be created using the object. | |
Sets or retrieves the language to use. | |
Sets or retrieves the language in which the current script is written. Note This has been superceded by the type attribute for the script element. If you are using javascript alone, you don't need to specify a type or language with the script element.
| |
Gets a reference to the last child in the childNodes collection of an object. | |
Retrieves a reference to the last child element or NULL if there are no child elements. | |
Retrieves a reference to the sibling element that immediately follows or NULL if the element does not have any sibling elements that follow it. | |
Retrieves a reference to the next child of the parent for the object. | |
Gets the name of a particular type of node. | |
Retrieves the type of the requested node. | |
Gets or sets the value of a node. | |
Sets or gets whether clicks in this region cause action. | |
Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object. | |
Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
Sets or retrieves the object and its content in HTML. | |
Sets or retrieves the text of the object. | |
Retrieves the document object associated with the node. | |
Retrieves the parent object in the object hierarchy. | |
Retrieves the parent object in the document hierarchy. | |
Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object. | |
Sets or retrieves the file name or path specified by the object. | |
Sets or retrieves the port number associated with a URL. | |
Retrieves a reference to the immediately preceding sibling element or NULL if the element does not have any preceding siblings. | |
Gets a reference to the previous child of the parent for the object. | |
Sets or retrieves the protocol portion of a URL. | |
Retrieves the current state of the object. | |
Retrieves the ordinal record from the data set that generated the object. | |
Sets or retrieves the role for this element. | |
Gets the namespace defined for the element. This property is not supported for Windows apps using JavaScript. | |
Sets or retrieves the substring of the href property that follows the question mark. | |
Sets or retrieves the shape of the object. | |
Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection. | |
Sets an inline style for the element. | |
Sets or retrieves the index that defines the tab order for the object. | |
Retrieves the tag name of the object. | |
Sets or gets the URN specified in the namespace declaration. This property is not supported for Windows apps using JavaScript. | |
Sets or retrieves the window or frame at which to target content. | |
Sets or retrieves advisory information (a ToolTip) for the object. | |
Retrieves an autogenerated, unique identifier for the object. | |
Retrieves the element's unique number. |
Standards information
- Document Object Model (DOM) Level 2 HTML Specification, Section 1.6.5
- HTML 4.01 Specification, Section 13.6.1
Remarks
Any number of area elements can be contained within the same map element.
The format of the coords value depends on the value of the shape attribute.
Windows Internet Explorer 8 and later. In IE8 Standards mode, the title attribute is preferred over the alt attribute when specified as a pop-up tooltip for an img or a map element. In addition, the value of the href attribute depends on the current document compatibility mode.
This element is not rendered.
This element does not require a closing tag.
Examples
The following example uses the area element inside a parent map element to create an image map of the solar system. Each area element defines and provides a link to an image on the map using the coords and shape attributes to specify its dimensions and shape, respectively; and the title attribute to provide a descriptive pop-up tooltip when pointed to with the mouse. A tooltip is especially useful if the image file is missing or cannot be displayed for whatever reason.
Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/imagemap.htm
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=8"/>
<title>Image Map Example</title>
<base href="http://samples.msdn.microsoft.com"/>
</head>
<body>
<p><img src="/workshop/graphics/solarsys.png" width=504 height=126 border=0
title="Solar System" usemap="#SystemMap"/></p>
<map name="SystemMap">
<area shape="rect" coords="0,0,82,126"
href="/workshop/graphics/sun.png" title="Sun"/>
<area shape="circle" coords="90,58,3"
href="/workshop/graphics/merglobe.png" title="Mercury"/>
<area shape="circle" coords="124,58,8"
href="/workshop/graphics/venglobe.png" title="Venus"/>
<area shape="circle" coords="162,58,10"
href="/workshop/graphics/earglobe.png" title="Earth"/>
<area shape="circle" coords="203,58,8"
href="/workshop/graphics/marglobe.png" title="Mars"/>
<area shape="poly" coords="221,34,238,37,257,32,278,44,284,60,
281,75,288,91,267,87,253,89,237,81,229,64,228,54"
href="/workshop/graphics/jupglobe.png" title="Jupiter"/>
<area shape="poly" coords="288,19,316,39,330,37,348,47,351,66,
349,74,367,105,337,85,324,85,307,77,303,60,307,50"
href="/workshop/graphics/satglobe.png" title="Saturn"/>
<area shape="poly" coords="405,39,408,50,411,57,410,71,404,78,
393,80,383,86,381,75,376,69,376,56,380,48,393,44"
href="/workshop/graphics/uraglobe.png" title="Uranus"/>
<area shape="poly" coords="445,38,434,49,431,53,427,62,430,72,
435,77,445,92,456,77,463,72,463,62,462,53,455,47"
href="/workshop/graphics/nepglobe.png" title="Neptune"/>
<area shape="circle" coords="479,66,3"
href="/workshop/graphics/pluglobe.png" title="Pluto"/>
</map>
</body>
</html>
See also