SVGGeometryElement: isPointInStroke() method

The SVGGeometryElement.isPointInStroke() method determines whether a given point is within the stroke shape of an element. Normal hit testing rules apply; the value of the pointer-events property on the element determines whether a point is considered to be within the stroke. The point argument is interpreted as a point in the local coordinate system of the element.

Syntax

js

isPointInStroke(point)

Parameters

point

An object interpreted as a point in the local coordinate system of the element.

Return value

A boolean indicating whether the given point is within the stroke or not.

Examples

SVG

html

<svg
  viewBox="0 0 100 100"
  width="150"
  height="150"
  xmlns="http://www.w3.org/2000/svg">
  <circle
    id="circle"
    cx="50"
    cy="50"
    r="45"
    fill="white"
    stroke="black"
    stroke-width="10" />

  <circle cx="10" cy="10" r="5" fill="seagreen" />
  <circle cx="40" cy="30" r="5" fill="seagreen" />
  <circle cx="83" cy="17" r="5" fill="seagreen" />
</svg>

JavaScript

js

const circle = document.getElementById("circle");

try {
  // Point not in circle
  console.log("Point at 10,10:", circle.isPointInStroke(new DOMPoint(10, 10)));

  // Point in circle but not stroke
  console.log("Point at 40,30:", circle.isPointInStroke(new DOMPoint(40, 30)));

  // Point in circle stroke
  console.log("Point at 83,17:", circle.isPointInStroke(new DOMPoint(83, 17)));
} catch (e) {
  // for the browsers that still support the deprecated interface SVGPoint
  const svg = document.getElementsByTagName("svg")[0];
  const point = svg.createSVGPoint();

  // Point not in circle
  point.x = 10;
  point.y = 10;
  console.log("Point at 10,10:", circle.isPointInStroke(point));

  // Point in circle but not stroke
  point.x = 40;
  point.y = 30;
  console.log("Point at 40,30:", circle.isPointInStroke(point));

  // Point in circle stroke
  point.x = 83;
  point.y = 17;
  console.log("Point at 83,17:", circle.isPointInStroke(point));
}

Result

Specifications

Specification
Scalable Vector Graphics (SVG) 2
# __svg__SVGGeometryElement__isPointInStroke

Browser compatibility

BCD tables only load in the browser