The ProgressEvent interface represents events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an img, audio, video, style or link).
Documentation ProgressEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Constructor
Variables
Is a Boolean flag indicating if the total work to be done, and the amount of work already done, by the underlying process is calculable. In other words, it tells if the progress is measurable or not.
Is an unsigned long long representing the amount of work already performed by the underlying process. The ratio of work done can be calculated with the property and ProgressEvent.total. When downloading a resource using HTTP, this only represent the part of the content itself, not headers and other overhead.
Is an unsigned long long representing the total amount of work that the underlying process is in the progress of performing. When downloading a resource using HTTP, this only represent the content itself, not headers and other overhead.
Inherited Variables
Defined by Event
A Boolean indicating whether the event bubbles up through the DOM or not.
A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.
A Boolean indicating whether the event is cancelable.
A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.
A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent; it's possible this has been changed along the way through retargeting.
Indicates whether or not event.preventDefault() has been called on the event.
Indicates which phase of the event flow is being processed.
The explicit original target of the event (Mozilla-specific).
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent).
The original target of the event, before any retargetings (Mozilla-specific).
A historical property introduced by Internet Explorer and eventually adopted into the DOM specification in order to ensure existing sites continue to work. Ideally, you should try to use Event.preventDefault() and Event.defaultPrevented instead, but you can use returnValue if you choose to do so.
A reference to the target to which the event was originally dispatched.
The time at which the event was created (in milliseconds). By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.
The name of the event (case-insensitive).
Inherited Methods
Defined by Event
Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
@:value({ cancelable : false, bubbles : false })initEvent(type:String, bubbles:Bool = false, cancelable:Bool = false):Void
Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.
Cancels the event (if it is cancelable).
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
Stops the propagation of events further along in the DOM.