Back to Content

SVGPointList: initialize() method

files/en-us/web/api/svgpointlist/initialize/index.md

latest1.3 KB
Original Source

{{APIRef("SVG")}}

The initialize() method of the {{domxref("SVGPointList")}} interface clears the list then adds a single new {{domxref("DOMPoint")}} object to the list.

Syntax

js-nolint
initialize(obj)

Parameters

  • obj
    • : A {{domxref("DOMPoint")}} object containing the coordinates of the point to be added when the list is initialized.

Return value

The added {{domxref("DOMPoint")}} object.

Exceptions

  • NoModificationAllowedError {{domxref("DOMException")}}
    • : Thrown if the list is read-only.

Examples

The following example shows an SVG which contains a {{SVGElement("polyline")}} with five coordinate pairs. Returning {{domxref("SVGPointList.length")}} gives the value 5. After calling initialize(), returning {{domxref("SVGPointList.length")}} gives the value 1.

html
<svg id="svg" viewBox="-10 -10 120 120" xmlns="http://www.w3.org/2000/svg">
  <polyline
    id="example"
    stroke="black"
    fill="none"
    points="50,0 21,90 98,35 2,35 79,90" />
</svg>
js
const example = document.getElementById("example");
console.log(example.points.length); // 5;
const point = document.getElementById("svg").createSVGPoint();
example.points.initialize(point);
console.log(example.points.length); // 1

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}