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.



new (type:String, ?eventInitDict:ProgressEventInit)





read onlylengthComputable:Bool

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.

read onlyloaded:Int

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 When downloading a resource using HTTP, this only represent the part of the content itself, not headers and other overhead.

read onlytotal:Int

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

read onlybubbles:Bool

A Boolean indicating whether the event bubbles up through the DOM or not.

read onlycancelable:Bool

A Boolean indicating whether the event is cancelable.

read onlycurrentTarget:EventTarget

A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent to; it's possible this has been changed along the way through retargeting.

read onlydefaultPrevented:Bool

Indicates whether or not event.preventDefault() has been called on the event.

read onlyeventPhase:Int

Indicates which phase of the event flow is being processed.

read onlyexplicitOriginalTarget:EventTarget

The explicit original target of the event (Mozilla-specific).

read onlyisTrusted:Bool

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)

read onlyoriginalTarget:EventTarget

The original target of the event, before any retargetings (Mozilla-specific).

read onlytarget:EventTarget

A reference to the target to which the event was originally dispatched.

read onlytimeStamp:Float

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.

read onlytype:String

The name of the event (case-insensitive).

Inherited Methods

Defined by Event

getPreventDefault ():Bool

Non-standard. Returns the value of Event.defaultPrevented. UseĀ Event.defaultPrevented instead.

initEvent (type:String, bubbles:Bool, cancelable:Bool):Void

Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.

preventDefault ():Void

Cancels the event (if it is cancelable).

stopImmediatePropagation ():Void

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)

stopPropagation ():Void

Stops the propagation of events further along in the DOM.