SVGAnimationElement: repeatEvent event

The repeatEvent event of the SVGAnimationElement interface is fired when the element's local timeline repeats. It will be fired each time the element repeats, after the first iteration.

Note: Associated with the repeatEvent event is an integer that indicates which repeat iteration is beginning; this can be found in the detail property of the event object. The value is a 0-based integer, but the repeat event is not raised for the first iteration and so the observed values will be >= 1. This is supported in Firefox, but not in Chrome.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

addEventListener('repeatEvent', event => { });

onrepeat = event => { };

Event type

An TimeEvent. Inherits from Event.

Event properties

TimeEvent.detail Read only: Is a long that specifies some detail information about the Event, depending on the type of the event. For this event type, indicates the repeat number for the animation.
TimeEvent.view Read only: Is a WindowProxy that identifies the Window from which the event was generated.

Examples

Animated circle

<svg xmlns="http://www.w3.org/2000/svg" width="300px" height="100px">
  <title>SVG SMIL Animate with Path</title>
  <circle cx="0" cy="50" r="50" fill="blue" stroke="black" stroke-width="1">
    <animateMotion
       path="M 0 0 H 300 Z"
       dur="5s" repeatCount="indefinite" />
  </circle>
</svg>

<hr>

<ul>

</ul>

ul {
  height: 100px;
  border: 1px solid #ddd;
  overflow-y: scroll;
  padding: 10px 30px;
}

let svgElem = document.querySelector('svg');
let animateElem = document.querySelector('animateMotion');
let list = document.querySelector('ul');

animateElem.addEventListener('beginEvent', () => {
  let listItem = document.createElement('li');
  listItem.textContent = 'beginEvent fired';
  list.appendChild(listItem);
})

animateElem.addEventListener('repeatEvent', (e) => {
  let listItem = document.createElement('li');
  let msg = 'repeatEvent fired';
  if(e.detail) {
    msg += '; repeat number: ' + e.detail;
  }
  listItem.textContent = msg;
  list.appendChild(listItem);
})

Event handler property equivalent

Note that you can also create an event listener for the repeat event using the onrepeat event handler property:

animateElem.onrepeat = () => {
  console.log('repeatEvent fired');
}

Specifications

Specification
Scalable Vector Graphics (SVG) 1.1 (Second Edition) # RepeatEvent

Browser compatibility

BCD tables only load in the browser