HTMLImageElement: useMap property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

TheuseMap property of theHTMLImageElement interface providing the name of the client-side image map to apply to the image. It reflects the<img> element'susemap content attribute.

Value

A string containing the hash# symbol followed by thename of the<map> element which defines the image map to apply to the image.

Examples

Using useMap

Consider a<map> that looks like this:

html

<map name="mainmenu-map">  <area    shape="circle"    coords="25, 25, 75"    href="/index.html"    alt="Return to home page" />  <area shape="rect" coords="25, 25, 100, 150" href="/index.html" alt="Shop" /></map>

Given the image map namedmainmenu-map, you can dynamically construct images that reference the image map as follows:

const image = new Image();image.src = "menu-box.png";image.alt = "";image.useMap = "#mainmenu-map";

For additional examples (including interactive ones), see the articles about the<map> and<area> elements, as well as theguide to using image maps.