In order to access this site you need to enable JavaScript!

You are here: Reference > JavaScript > client-side > HTML DOM > objects > nodes and tags > area

area object

Browser support:

Defines a hyperlink region within an image map.

The area element specifies a region and a link within an image object. It is a perfect choice if you want to assign multiple links to multiple regions within an image, or one link to a portion of an image.

Syntax:

Methods that return the object:

•	document.createElement ("area")
•	links.item (nameOrIndex [, subIndex])
•	areas.item (nameOrIndex [, subIndex])
•	links.namedItem (name)
•	areas.namedItem (name)

The base interface, through which you can add new functionalities to the area object, is the HTMLAreaElement interface.

If you want to see the HTML objects by categories, please visit this page.

HTML page for this element: area

Possible members:

Properties

Methods

Events

Style properties

accessKey

Sets or retrieves an access key to an element.

alt

Sets or retrieves an alternate text that is displayed when the file associated with the element cannot be displayed.

attributes

Represents a collection of attribute nodes that belong to an element.

baseURI

			10

Returns the base URL for the object.

behaviorUrns

Represents a collection of the Uniform Resource Names for all behaviors attached to an element.

canHaveChildren

Retrieves a Boolean value that indicates whether the element can contain child elements.

canHaveHTML

Retrieves a Boolean value that indicates whether the element can contain HTML formatted text.

className

Sets or retrieves the style class or classes that belong to the element.

contentEditable

	3

Sets or retrieves whether the contents of the object are editable.

coords

Sets or retrieves the position of a shape. You can select the type of shape with the shape property.

currentStyle

Represents the computed style settings for an element.

dir

Sets or retrieves the text direction as related to the lang property.

disabled

Sets or retrieves the state of an object for user interaction.

draggable

	3.5		5

Sets or retrieves whether an element is draggable.

hash

Sets or returns the subsection (begins with a '#' sign) of the URL assigned to the object.

hideFocus

Specifies or returns whether a dotted rectangle (focus rectangle) is drawn around an object while it has focus.

host

Specifies or retrieves the host name and port of the URL assigned to the object.

hostname

Specifies or retrieves the host name of the URL assigned to the object.

href

Specifies or returns the location of the destination.

Sets or retrieves a unique identifier for the object.

isContentEditable

Returns a Boolean value that indicates whether the contents of the object are editable by the user.

isDisabled

Returns a Boolean value that indicates whether the object is disabled.

isMultiLine

Returns a Boolean value that indicates whether the contents of an element can be multiline or not.

isTextEdit

Returns a Boolean value that indicates whether the createTextRange method can be used for the element.

lang

Specifies or returns the language of the element.

language

Sets or retrieves the scripting language for the current element. Use it only for the script element.

localName

9

Returns the local part of the qualified name of the current node.

name

Sets or retrieves the name of an element.

namespaceURI

9	3.6

Sets or returns the namespace URI of the current node.

nextElementSibling

9	3.5

Returns a reference to the next child element of the current element's parent.

nextSibling

Returns a reference to the next child of the current element's parent.

nodeName

Returns the name of the current node.

nodeType

Returns an integer that indicates the type of the node.

nodeValue

Sets or returns the value of the current node.

noHref

Sets or retrieves whether an area is a link.

offsetHeight

Returns the height of the visible area for an object, in pixels. The value contains the height with the padding, scrollBar, and the border, but does not include the margin.

offsetLeft

Returns the left position of an object relative to the left side of its offsetParent element, in pixels.

offsetParent

Returns a reference to the closest ancestor element in the DOM hierarchy from which the position of the current element is calculated.

offsetTop

Returns the top position of the object relative to the top side of its offsetParent element, in pixels.

offsetWidth

Returns the width of the visible area for an object, in pixels. The value contains the width with the padding, scrollBar, and the border, but does not include the margin.

outerHTML

Sets or retrieves the outer HTML content (the source code including the opening and closing tags) of an element.

outerText

Sets or returns the text content of an element including the text content of its descendants.

ownerDocument

Returns the document object that contains the current node.

parentElement

Returns the parent element of the object in the DOM hierarchy.

parentNode

Returns the parent element of the current node in the DOM hierarchy.

parentTextEdit

Returns the closest ancestor element of the current element in the DOM hierarchy that can be used to create a TextRange object.

pathname

Specifies or retrieves the path component of the URL assigned to the object (relative to the host).

port

Sets or retrieves the port component of the URL assigned to the object.

previousElementSibling

9	3.5

Returns a reference to the previous child element of the current element's parent.

previousSibling

Returns a reference to the previous node of the current element's parent.

protocol

Sets or retrieves the protocol component of the URL assigned to the object.

readyState

Returns a string value that represents the state of the object.

runtimeStyle

Represents the overridden style settings for an element.

scopeName

Retrieves the local name of the namespace declared for the current element.

Sets or returns the subsection (begins with a '?' sign) of the URL assigned to the object.

shape

Sets or retrieves the shape type of the selectable region for a hypertext or an area.

sourceIndex

Returns the position of the current object in the all collection of the document.

style

Represents the inline style settings for an element or a CSS rule.

tabIndex

Specifies or returns the tabbing order for keyboard navigation using the TAB key.

tagName

Returns the tag name of the current element.

tagUrn

Sets or retrieves the Uniform Resource Name (URN) of the namespace declared for the current element.

target

Specifies or returns the target window or frame where the document is to be opened.

title

Specifies or returns a tooltip for an element.

uniqueID

Returns the unique identifier generated by the browser for the object.

unselectable

Sets or retrieves whether the selection process can start in an element's content.

addBehavior

Attaches the specified behavior to the current element.

addEventListener

9

Registers an event handler function (event listener) for the specified event on the current object.

applyElement

Inserts the specified element as a child or parent of the current element.

attachEvent

Registers an event handler function (event listener) for the specified event on the current object.

blur

Removes the focus from the current element, and fires the onblur event.

clearAttributes

Clears all attributes from the current element, except the id, name, style, value and event attributes.

click

Simulates a mouse click on the current element.

cloneNode

Returns an exact copy of the current node.

compareDocumentPosition

9

Compares the placement of the specified node with the current node in the DOM hierarchy.

componentFromPoint

Returns the region of the current element that is located at the specified coordinates.

detachEvent

Removes the specified event handler from the current element that was registered earlier with the attachEvent method.

dispatchEvent

9

Dispatches the specified event to the current element.

dragDrop

Initiates a drag-and-drop operation.

fireEvent

Initializes an event object and dispatches it to the current element.

focus

Sets the focus on the current element.

getAdjacentText

Returns the contents of the TextNode located at the specified position relative to the current element.

getAttribute

Returns the value of the attribute with the specified name from the current element.

getAttributeNode

Returns the attribute node with the specified name from the current element.

getAttributeNodeNS

9

Returns the attribute node with the specified namespace and name from the current element.

getAttributeNS

9

Returns the value of the attribute with the specified namespace and name from the current element.

getBoundingClientRect

	3	9.5	4

Returns a TextRectangle object that specifies the bounding rectangle of the current element or TextRange object, in pixels, relative to the upper-left corner of the browser's client area.

getClientRects

	3	9.5	4

Retrieves a TextRectangles collection that specifies the exact shape of the current element or TextRange object.

getExpression


9

Returns the dynamic expression for the specified DHTML property on the current element.

hasAttribute

8

Returns whether the current element has an attribute with the specified name or not.

hasAttributeNS

9

Returns whether the current element has an attribute with the specified namespace and name or not.

hasAttributes

8

Returns whether the current element has any attributes specified or not.

hasChildNodes

Returns whether the current node has any child nodes or not.

insertAdjacentElement

Inserts an element at the specified position relative to the current element.

insertAdjacentHTML

Inserts a HTML formatted text at the specified position relative to the current element.

insertAdjacentText

Creates a new TextNode from the specified text and inserts it at the specified position relative to the current element.

isDefaultNamespace

9

Returns whether the specified namespace URI is the default namespace in the scope of the current node.

isEqualNode

9

Returns whether the current node is equal to the specified one.

isSameNode

9

Returns whether the current node is the same node as the specified one.

isSupported

9

Returns whether the specified DOM module and version is supported by the current node.

mergeAttributes

Copies all attributes and its values from the specified element to the current element.

normalize

Puts the subtree that belongs to the current node into a 'normalized' form.

releaseCapture

Releases the mouse capture from the browser window that was previously set by the setCapture method and restores the normal event processing.

removeAttribute

Removes the attribute with the specified name from the current element.

removeAttributeNode

Removes the specified attribute node from the current element.

removeAttributeNS

9

Removes the attribute with the specified namespace and name from the current element.

removeBehavior

Removes the specified behavior from the current element.

removeEventListener

9

Removes the specified event handler from the current element that was registered earlier with the addEventListener method.

removeExpression


9

Removes the dynamic expression from the specified DHTML property on the current element.

removeNode

Removes the current element with or without its children from the document tree.

replaceAdjacentText

Replace the contents of the TextNode located at the specified position relative to the current element with the specified text.

replaceNode

Replaces the current element with the specified element.

scrollIntoView

Scrolls the specified element into the visible area of the document.

setActive

Sets the element as the active element in the current document.

setAttribute

Adds an attribute with the specified name and value to the current element.

setAttributeNode

Adds the specified attribute node to the current element.

setAttributeNodeNS

9

Adds the specified attribute node to the current element.

setAttributeNS

9

Adds an attribute with the specified namespace, name and value to the current element.

setCapture

Sets the current object to capture mouse events that occur within the entire browser window.

setExpression


9

Sets a dynamic expression for the specified DHTML property on the current element.

swapNode

Interchanges the positions of the current element and the specified element in the document hierarchy.

onactivate

Occurs when an element becomes active.

onbeforeactivate

Occurs before an element becomes active.

onbeforecopy

Occurs before the selection is copied to the clipboard and before the oncopy event.

onbeforecut

Occurs before the selection is cut from the document and provides a possibility to enable the Cut menu item.

onbeforedeactivate

Occurs on the active element before it loses the active state.

onbeforeeditfocus

Occurs before an input:file, input:password, input:text or textarea element or an element in an editable region becomes a UI-activated.

onbeforepaste

Occurs before the contents of the clipboard are pasted into the document and provides a possibility to enable the Paste menu item.

onblur

Occurs when an element loses focus.

onclick

Occurs when the user clicks on an element.

oncontextmenu

Occurs when the right mouse button is clicked on an element and the context menu is shown.

oncontrolselect

Occurs before a control is selected in an editable region.

oncopy

Occurs before the selection is copied to the clipboard.

oncut

Occurs before the selection is cut from the document and added to the clipboard.

ondblclick

Occurs when the user double clicks on an element.

ondeactivate

Occurs on the active element when it loses the active state.

ondrag

	3

Occurs periodically on the source element during the drag operation.

ondragend

	3

Occurs on the source element when the user has finished the drag operation.

ondragenter

Occurs on an element when the user moves the mouse pointer into it during a drag operation.

ondragleave

	3.5

Occurs on an element when the user moves the mouse pointer out of it during a drag operation.

ondragover

Occurs periodically on an element while the mouse pointer is over it during a drag operation.

ondragstart

	3.5

Occurs on the source element when the user starts the drag operation.

ondrop

	3.5

Occurs on a possible target element when the dragged data is dropped on it.

onfilterchange

Occurs after a filter has changed or finished a transition.

onfocus

Occurs when an element receives focus.

onfocusin

Occurs before an element receives focus.

onfocusout

Occurs after an element loses focus.

onhelp

Occurs after the user has pressed the F1 key.

onkeydown

Occurs on an element that has the focus when a key is pressed down and occurs periodically until the key is released.

onkeypress

Occurs on an element that has the focus when a key is pressed down and occurs periodically until the key is released.

onkeyup

Occurs on an element that has the focus when the user releases a key.

onlosecapture

Occurs when the object loses the mouse capture.

onmousedown

Occurs when the user presses a mouse button over an element.

onmouseenter

Occurs when the user moves the mouse pointer into the area of an element.

onmouseleave

Occurs when the user moves the mouse pointer out of the element.

onmousemove

Occurs when the user moves the mouse over the element.

onmouseout

Occurs when the user moves the mouse pointer out of the element.

onmouseover

Occurs when the user moves the mouse pointer into the element.

onmouseup

Occurs when the user releases a mouse button over an element.

onmousewheel

Occurs when the mouse wheel rolls.

onmove

Occurs when the position of an element's top-left corner is changed.

onmoveend

Occurs when the user stops dragging an absolute or relative positioned element in an editable region.

onmovestart

Occurs when the user starts dragging an absolute or relative positioned element in an editable region.

onpaste

Occurs before the contents of the clipboard are pasted into the document.

onpropertychange

Occurs every time when the value of an element's property is changed.

onreadystatechange

Occurs when the load state of the data that belongs to an element or a HTML document changes.

onresize

Occurs when the size of an object has changed.

onresizeend

Occurs when the user stops resizing an element in an editable region.

onresizestart

Occurs when the user starts to resize an element in an editable region.

onselectstart

Occurs at the start of a selection process.

behavior

Sets or retrieves the URL of a behavior file.

cssText

Sets or retrieves the contents of a style declaration as a string.

hasLayout

Returns a Boolean value that indicates whether the object has layout or not.

length

9

Returns the number of properties that have been set in the current style object.

pixelBottom

Specifies or retrieves the value of the bottom style property, in pixels.

pixelHeight

Specifies or retrieves the value of the height style property, in pixels.

pixelLeft

Specifies or retrieves the value of the left style property, in pixels.

pixelRight

Specifies or retrieves the value of the right style property, in pixels.

pixelTop

Specifies or retrieves the value of the top style property, in pixels.

pixelWidth

Specifies or retrieves the value of the width style property, in pixels.

posBottom

Specifies or retrieves the value of the bottom style property as a floating-point number that specifies the value in the current unit type of the bottom property.

posHeight

Specifies or retrieves the value of the height style property as a floating-point number that specifies the value in the current unit type of the height property.

posLeft

Specifies or retrieves the value of the left style property as a floating-point number that specifies the value in the current unit type of the left property.

posRight

Specifies or retrieves the value of the right style property as a floating-point number that specifies the value in the current unit type of the right property.

posTop

Specifies or retrieves the value of the top style property as a floating-point number that specifies the value in the current unit type of the top property.

posWidth

Specifies or retrieves the value of the width style property as a floating-point number that specifies the value in the current unit type of the width property.

Example HTML code 1:

This example illustrates the use of the area element:

<img src="area.gif" width="504px" height="126px" border="0px" alt="Solar System" usemap="#SampleMap" />
<map name="SampleMap">
    <area shape="rect" coords="1,-1,83,125" alt="rectangle" href="#" />
    <area shape="circle" coords="234,57,30" alt="circle" href="#" />
    <area shape="poly" coords="363,37,380,40,399,35,420,47,426,63,423,78,430,94,409,90,395,92,379,84,371,67,370,57" alt="polygon" href="#" />
</map>

Copy Code

Preview

Syntax Highlighter

Did you find this example helpful? yes no

Example HTML code 2:

This example shows how to get the radius of a circle shape in JavaScript:

<head>
    <script type="text/javascript">
        function GetCircleRadius () {
            var circle = document.getElementById ("circleShape");
            var coords = circle.coords.split (",");
            var radius = parseFloat (coords[2]);

            alert (radius + "px");
        }
    </script>
</head>
<body>
    <img src="area.gif" width="504px" height="126px" border="0px" alt="Solar System" usemap="#SampleMap" />
    <map name="SampleMap">
        <area shape="rect" coords="1,-1,83,125" alt="rectangle" href="#" />
        <area id="circleShape" shape="circle" coords="234,57,30" alt="circle" href="#" />
        <area shape="poly" coords="363,37,380,40,399,35,420,47,426,63,423,78,430,94,409,90,395,92,379,84,371,67,370,57" alt="polygon" href="#" />
    </map>
    <br /><br />
    <button onclick="GetCircleRadius ();">Get the radius of the circle!</button>
</body>