SVGPathElement: getPointAtLength() method

The getPointAtLength() method of the SVGPathElement interface returns the point at a given distance along the path.

Syntax

js
getPointAtLength(distance)

Parameters

distance

A number indicating the distance along the path

Return value

A DOMPoint indicating the point at a given distance along the path.

Examples

Getting the midpoint of a <path>

In this example, we determine the midpoint of a path by getting the point that is half way along the length of the path.

We define an SVG that includes two paths: a basic line and a complex heart shape.

The path that creates the heart is approximately 275 units long.

html
<svg width="200" height="100">
  <path
    id="heart"
    fill="red"
    d="M 10,30
           A 20,20 0,0,1 50,30
           A 20,20 0,0,1 90,30
           Q 90,60 50,90
           Q 10,60 10,30 z" />
  <path id="line" d="M 0,30 h100" stroke="black" />
</svg>

The line is horizontal, starting at 0, 30 and is 100 units long. The path of the heart starts at 10, 30 and is approximately 275 units long.

We know the length of the line is 100 units, and hence that 50 is the mid point. We use the SVGPathElement.getTotalLength() method to get the length of the heart's path, dividing it by 2 to get the mid-point distance. We then use the getPointAtLength() method to return the mid point as a DOMPoint. We display the x and y coordinates for each mid point.

js
const basicPath = document.getElementById("line");
const complexPath = document.getElementById("heart");

// Get the length of the heart and divide by 2
const halfLength = complexPath.getTotalLength() / 2;

// Access the getPointAtLength property
const basicMidPoint = basicPath.getPointAtLength(50);
const complexMidPoint = complexPath.getPointAtLength(halfLength);

// The base value of the pathLength attribute
log(`Line mid point: ${basicMidPoint.x}, ${basicMidPoint.y}`);
log(`Heart mid point: ${complexMidPoint.x}, ${complexMidPoint.y}`);

Specifications

Specification
SVG Paths
# __svg__SVGPathElement__getPointAtLength

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getPointAtLength
Chrome – Full support
Chrome 1 (Release date: 2008-12-11)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – Full support
Firefox 1.5 (Release date: 2005-11-29)
footnote Full support
Opera – Full support
Opera 15 (Release date: 2013-07-02)
footnote Full support
Safari – Full support
Safari 3 (Release date: 2007-10-26)
footnote Full support
Chrome Android – Full support
Chrome Android 18 (Release date: 2012-06-27)
footnote Full support
Firefox for Android – Full support
Firefox for Android 4 (Release date: 2011-03-29)
footnote Full support
Opera Android – Full support
Opera Android 14 (Release date: 2013-05-21)
footnote Full support
Safari on iOS – Full support
Safari on iOS 2 (Release date: 2008-07-11)
footnote Full support
Samsung Internet – Full support
Samsung Internet 1 (Release date: 2013-04-27)
footnote Full support
WebView Android – Full support
WebView Android 4.4 (Release date: 2013-12-09)
footnote Full support
WebView on iOS – Full support
WebView on iOS 2 (Release date: 2008-07-11)
footnote Full support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also