map element | map object (Windows)

2 out of 3 rated this helpful - Rate this topic

Contains coordinate data for client-side image maps.

Document Object Model (DOM) Level 2 HTML Specification, Section 1.6.5

DOM Information

Inheritance Hierarchy

Node

Element

HTMLElement

map

Members

The map object has these types of members:

Events
Methods
Properties

Events

The map object has these events.

Event	Description
abort	Fires when the user aborts the download.
beforeactivate	Fires immediately before the object is set as the active element.
change	Fires when the contents of the object or selection have changed.
click	Fires when the user clicks the left mouse button on the object.
dblclick	Fires when the user double-clicks the object.
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.
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.
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.
load	Fires immediately after the client loads the object.
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.
onkeyup	Fires when the user releases a key.
onselect	Fires when the current selection changes.
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.
scroll	Fires when the user repositions the scroll box in the scroll bar on the object.

Methods

The map object has these methods.

Method	Description
appendChild	Appends an element as a child to the object.
applyElement	Makes the element either a child or parent of another element.
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.
doScroll	Simulates a click on a scroll bar component.
dragDrop	Initiates a drag 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.
insertBefore	Inserts an element into the document hierarchy as a child node of a parent object.
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.
removeChild	Removes a child node from the object.
removeNode	Removes the object from the document hierarchy.
replaceAdjacentText	Replaces the text adjacent to the element.
replaceChild	Replaces an existing child element with a new child 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 map object has these properties.

Property	Description
animation	Specifies one or more shorthand values that define all animation properties (except animation-play-state) for a set of corresponding object properties identified in the CSS @keyframes at-rule specified by the animations-name property.
animationDelay	Specifies the offset within an animation cycle (the amount of time from the start of a cycle) before the animation is displayed for a set of corresponding object properties identified in the CSS @keyframes at-rule specified by the animation-name property.
animationDirection	Specifies the direction of play for an animation cycle.
animationDuration	Specifies the length of time to complete one cycle of the animation.
animationFillMode	Specifies whether the effects of an animation are visible before or after it plays.
animationIterationCount	Specifies the number of times an animation cycle is played.
animationName	Identifies one or more animation names. An animation name selects a CSS @keyframes at-rule.
animationPlayState	Specifies whether an animation is playing or paused.
animationTimingFunction	Specifies the intermediate property values to be used during a single cycle of an animation on a set of corresponding object properties identified in the CSS @keyframes at-rule specified by the animation-name property.
attributes	Retrieves a collection of attributes of the object.
backfaceVisibility	Gets or sets a value that specifies whether the back face (reverse side) of an object is visible.
breakAfter	Gets or sets the column-break behavior that follows a content block in a multi-column element.
breakBefore	Gets or sets the column-break behavior that precedes a content block in a multi-column element.
breakInside	Gets or sets the column-break behavior that occurs within a content block in a multi-column element.
canHaveChildren	Gets a value indicating whether the object can contain child objects.
canHaveHTML	Retrieves the value indicating whether the object can contain rich HTML markup.
childElementCount	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.
className	Sets or retrieves the class of the object.
columnCount	Gets or sets the optimal number of columns in a multi-column element.
columnFill	Gets or sets a value that indicates how the column lengths in a multi-column element are affected by the content flow.
columnGap	Gets or sets the width of the gap between columns in a multi-column element.
columnRule	Gets or sets a shorthand value that specifies values for the columnRuleWidth, columnRuleStyle, and the columnRuleColor of a multi-column element.
columnRuleColor	Gets or sets the color for all column rules in a multi-column element.
columnRuleStyle	Gets or sets the style for all column rules in a multi-column element.
columnRuleWidth	Gets or sets the width of all column rules in a multi-column element.
columnSpan	Gets or sets the number of columns that a content block spans in a multi-column element.
columnWidth	Gets or sets the optimal width of the columns in a multi-column element.
constructor	Returns a reference to the constructor of an object.
dir	Sets or retrieves the reading order of the object.
firstChild	Gets a reference to the first child in the childNodes collection of the object.
firstElementChild	Retrieves a reference to the first child element, or NULL if there are no child elements.
id	Sets or retrieves the string identifying the object.
innerHTML	Sets or retrieves the HTML between the start and end tags of the object.
innerText	Sets or retrieves the text between the start and end tags of the object.
isContentEditable	Gets the value that indicates whether the user can edit the contents of the object.
isDisabled	Gets the value that indicates whether the user can interact with the object.
isMultiLine	Retrieves the value indicating whether the content of the object contains one or more lines.
isTextEdit	Retrieves whether a TextRange object can be created using the object.
lang	Sets or retrieves the language to use.
lastChild	Gets a reference to the last child in the childNodes collection of an object.
lastElementChild	Retrieves a reference to the last child element or NULL if there are no child elements.
msGridColumn	Gets or sets a value that specifies in which column of the grid to place the object.
msGridColumnAlign	Gets or sets a value that specifies the horizontal alignment of the object within the grid column.
msGridColumns	Gets or sets one or more values that specify the width of each grid column within the object.
msGridColumnSpan	Gets or sets a value that specifies the number of columns of the grid that the object spans.
msGridRow	Gets or sets a value that specifies in which row of the grid to place the object.
msGridRowAlign	Gets or sets a value that specifies the vertical alignment of the object within the grid row.
msGridRows	Gets or sets one or more values that specify the height of each grid row within the object.
msGridRowSpan	Gets or sets a value that specifies the number of rows of the grid that the object spans.
name	Sets or retrieves the name of the object.
nextElementSibling	Retrieves a reference to the sibling element that immediately follows or NULL if the element does not have any sibling elements that follow it.
nextSibling	Retrieves a reference to the next child of the parent for the object.
nodeName	Gets the name of a particular type of node.
nodeType	Retrieves the type of the requested node.
nodeValue	Gets or sets the value of a node.
offsetHeight	Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetLeft	Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetParent	Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object.
offsetTop	Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetWidth	Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
outerHTML	Sets or retrieves the object and its content in HTML.
outerText	Sets or retrieves the text of the object.
ownerDocument	Retrieves the document object associated with the node.
parentElement	Retrieves the parent object in the object hierarchy.
parentNode	Retrieves the parent object in the document hierarchy.
parentTextEdit	Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object.
perspective	Gets or sets a value that represents the perspective from which all child elements of the object are viewed.
perspectiveOrigin	Gets or sets one or two values that represent the origin (the vanishing point for the 3-D space) of an object with an perspective property declaration.
previousElementSibling	Retrieves a reference to the immediately preceding sibling element or NULL if the element does not have any preceding siblings.
previousSibling	Gets a reference to the previous child of the parent for the object.
readyState	Retrieves the current state of the object.
role	Sets or retrieves the role for this element.
sourceIndex	Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection.
STYLE	Sets an inline style for the element.
tagName	Retrieves the tag name of the object.
title	Sets or retrieves advisory information (a ToolTip) for the object.
transformStyle	Gets or sets a value that specifies how child elements of the object are rendered in 3-D space.
transition	Gets or sets one or more shorthand values that specify the transition properties for a set of corresponding object properties identified in the transition-property property.
transitionDelay	Gets or sets one or more values that specify the offset within a transition (the amount of time from the start of a transition) before the transition is displayed for a set of corresponding object properties identified in the transition property.
transitionDuration	Gets or sets one or more values that specify the durations of transitions on a set of corresponding object properties identified in the transition-property property.
transitionProperty	Gets or sets a value that identifies the CSS property name or names to which the transition effect (defined by the transition-duration, transition-timing-function, and transition-delay properties) is applied when a new property value is specified.
transitionTimingFunction	Gets or sets one or more values that specify the intermediate property values to be used during a transition on a set of corresponding object properties identified in the transition-property property.
uniqueID	Retrieves an autogenerated, unique identifier for the object.
uniqueNumber	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

An image map is a graphic image, with predefined regions, that contains links to other documents or anchors. For example, you could create an image of the solar system containing links that the user can click to navigate to pages for the individual planets.

The map object is referenced with the USEMAP attribute in an IMG element, as follows:


<img src="solarsys.png" usemap="#SystemMap">

A MAP element contains a set of AREA elements defining the linking regions in the image.

Examples

This example provides the full code for an image map of the solar system. It creates links from the image map to individual images of the planets using the AREA element with the MAP element, COORDS value, and SHAPE attribute. The user clicks the sun or any planet to link to an individual image. To return to the solar system image map, the user clicks the Back button.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/imagemap.htm


<img src="solarsys.png" width="504" height="126" alt="Solar System" usemap="#SystemMap">
    <map name="SystemMap">
        <area shape="rect" coords="0,0,82,126" href="/workshop/graphics/sun.png" alt="sun">
        <area shape="circle" coords="90,58,3" href="/workshop/graphics/merglobe.png" alt="mercury">
        <area shape="circle" coords="124,58,8" href="/workshop/graphics/venglobe.png" alt="venus">
        <area shape="circle" coords="162,58,10" href="/workshop/graphics/earglobe.png" alt="earth">
        <area shape="circle" coords="203,58,8" href="/workshop/graphics/marglobe.png" alt="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" alt="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" alt="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" alt="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" alt="neptune">
        <area shape="circle" coords="479,66,3" href="/workshop/graphics/pluglobe.png" alt="pluto">
    </map>

Build date: 11/28/2012

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)