SVGAnimationElement: beginEvent event

{{APIRef("SVG")}}

The beginEvent event of the {{domxref("SVGAnimationElement")}} interface is fired when the element local timeline begins to play. It will be raised each time the element begins the active duration (i.e., when it restarts, but not when it repeats).

It may be raised both in the course of normal (i.e. scheduled or interactive) timeline play, as well as in the case that the element was begun with a DOM method.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}} , or set an event handler property.

addEventListener("beginEvent", (event) => {});

onbegin = (event) => {};

Event type

A {{domxref("TimeEvent")}} . Inherits from {{domxref("Event")}} .

{{InheritanceDiagram("TimeEvent")}}

Event properties

{{domxref("TimeEvent.detail")}} {{ReadOnlyInline}}
- : 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.
{{domxref("TimeEvent.view")}} {{ReadOnlyInline}}
- : A {{glossary("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);
});

{{EmbedLiveSample('Animated_circle', '100%', '270')}}

Event handler property equivalent

Note that you can also create an event listener for the begin event using the onbegin event handler property:

animateElem.onbegin = () => {
  console.log("beginEvent fired");
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

docs.rodeo

MDN Web Docs mirror