SVGSVGElement: animationsPaused() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

The animationsPaused() method of the SVGSVGElement interface checks whether the animations in the SVG document fragment are currently paused.

Syntax

js
animationsPaused()

Parameters

None.

Return value

A boolean. true if this SVG document fragment is in a paused state.

Examples

Checking if Animations are Paused

html
<svg id="exampleSVG" width="200" height="100">
  <circle cx="50" cy="50" r="30" fill="blue">
    <animate
      attributeName="cx"
      from="50"
      to="150"
      dur="2s"
      repeatCount="indefinite" />
  </circle>
</svg>

<button id="pauseBtn">Pause/Resume Animations</button>
<pre id="status"></pre>
js
const svgElement = document.getElementById("exampleSVG");
const pauseButton = document.getElementById("pauseBtn");
const statusDisplay = document.getElementById("status");

function updateStatus() {
  const isPaused = svgElement.animationsPaused();
  statusDisplay.textContent = `Animations paused: ${isPaused}`;
}

pauseButton.addEventListener("click", () => {
  if (svgElement.animationsPaused()) {
    svgElement.unpauseAnimations();
  } else {
    svgElement.pauseAnimations();
  }
  updateStatus();
});

// Initialize the status display
updateStatus();

Specifications

Specification
SVG Animations Level 2
# __svg__SVGSVGElement__animationsPaused

Browser compatibility

BCD tables only load in the browser

See also