TimeEvent: initTimeEvent() method

The TimeEvent.initTimeEvent() method initializes the value of a TimeEvent created using Document.createEvent().

This method may only be called before the event has been dispatched via EventTarget.dispatchEvent(). If called multiple times, the final call takes precedence.

Note: Document.createEvent() is deprecated in favor of event constructors, but TimeEvent has no dedicated constructor. CustomEvent is not a valid replacement, as it does not produce a TimeEvent instance with the interface's view and detail attributes.

Syntax

js
initTimeEvent(type)
initTimeEvent(type, view)
initTimeEvent(type, view, detail)

Parameters

type

A string specifying the event type.

view Optional

The Window from which the event was generated. If null or omitted, the TimeEvent.view attribute of the event will be null. Defaults to null.

detail Optional

A long providing contextual information about the event. Defaults to 0.

Return value

None (undefined).

Examples

undefined

Dispatching a repeatEvent

js
const evt = document.createEvent("TimeEvent");
evt.initTimeEvent("repeatEvent", window, 2);
svgElement.dispatchEvent(evt);

Specifications

See also