HTMLAreaElement: relList property

{{APIRef("HTML DOM")}}

The read-only relList property of the {{domxref("HTMLAreaElement")}} returns a live {{domxref("DOMTokenList")}} object containing the set of link types indicating the relationship between the resource represented by the {{HTMLElement("area")}} element and the current document. It reflects the {{HTMLElement("area")}} element's rel content attribute.

Value

A live {{domxref("DOMTokenList")}} object.

Although the relList property itself is read-only in the sense that you can't replace the DOMTokenList object, you can still assign to the relList property directly, which is equivalent to assigning to its {{domxref("DOMTokenList/value", "value")}} property. You can also modify the DOMTokenList object using the {{domxref("DOMTokenList/add", "add()")}}, {{domxref("DOMTokenList/remove", "remove()")}}, {{domxref("DOMTokenList/replace", "replace()")}}, and {{domxref("DOMTokenList/toggle", "toggle()")}} methods.

Examples

const areas = document.getElementsByTagName("area");

for (const area of areas) {
  console.log("New area found.");
  area.relList.forEach((relValue) => {
    console.log(relValue);
  });
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• The equivalent property on {{HTMLElement("a")}} and {{HTMLElement("link")}}, {{domxref("HTMLAnchorElement.relList")}} and {{domxref("HTMLLinkElement.relList")}}.
• The very same list but as a space-separated tokens in a string: {{domxref("HTMLAreaElement.rel")}}