Back to Content

SVGAElement: relList property

files/en-us/web/api/svgaelement/rellist/index.md

latest2.1 KB
Original Source

{{APIRef("SVG")}}

The read-only relList property of the {{domxref("SVGAElement")}} returns a live {{domxref("DOMTokenList")}} reflecting the space-separated string <list-of-Link-Types> values of the rel attribute of the SVG {{svgelement("a")}} element.

Value

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

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

Given the following SVG:

html
<svg viewBox="0 0 200 20" xmlns="http://www.w3.org/2000/svg">
  <!-- A link around a text -->
  <a href="/docs/Web/SVG/Reference/Element/text" rel="alternate bookmark">
    <text x="30" y="10">Link text</text>
  </a>
</svg>
html
<pre id="log"></pre>
css
#log {
  height: 70px;
  overflow: scroll;
  padding: 0.5rem;
  border: 1px solid black;
}
svg {
  height: 50px;
}
text {
  font-size: 1rem;
}
js
const logElement = document.querySelector("#log");
function log(text) {
  logElement.innerText = `${logElement.innerText}${text}\n`;
  logElement.scrollTop = logElement.scrollHeight;
}

We can retrieve every link type defined by <a> element's rel attribute:

js
// Select an SVG <a> element
const svgLink = document.querySelector("a");
const relations = svgLink.relList;

relations.forEach((relValue) => {
  log(relValue);
});

{{EmbedLiveSample("Example","100%","200")}}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • rel
  • {{domxref("SVGAElement.rel")}}
  • {{domxref("HTMLAnchorElement.relList")}}
  • {{domxref("HTMLLinkElement.relList")}}