mozilla

Revision 458873 of ProgressEvent

  • Revision slug: Web/API/ProgressEvent
  • Revision title: ProgressEvent
  • Revision id: 458873
  • Created:
  • Creator: teoli
  • Is current revision? No
  • Comment

Revision Content

{{eventref("Event")}}

The ProgressEvent interface represents events measuring progress of an underlying processus, like an HTTP request (for an XmlHTTPRequest, or the loading of the underlying resource of an {{HTMLElement("img")}}, {{HTMLElement("audio")}}, {{HTMLElement("video")}}, {{HTMLElement("style")}} or {{HTMLElement("link")}}).

Properties

Inherits properties from its parent {{domxref("Event")}}.

{{domxref("ProgressEvent.lengthComputable")}} {{readonlyInline}}
Is a {{domxref("Boolean")}} flag indicating if the total work to be done, and the amount of work already done, by the underlying processus is calculable. In other words, it tells if the progress is measurable or not.
{{domxref("ProgressEvent.loaded")}} {{readonlyInline}}
Is an unsigned long long representing the amount of work already performed by the underlying processus. The ratio of work done can be calculated with the property and ProgressEvent.total.
{{domxref("ProgressEvent.total")}} {{readonlyInline}}
Is an unsigned long long representing the total amount of work that the underlying processus is in the progress of performing.

Constructor

{{domxref("ProgressEvent.ProgressEvent", "ProgressEvent()")}}
Creates a ProgressEvent event with the given parameters.

Methods

No specific method; inherits methods from its parent {{domxref("Event")}}.

Specifications

Specification Status Comment
{{SpecName('Progress Events', '#interface-progressevent', 'ProgressEvent')}} {{Spec2('Progress Events')}} Initial definition.

Browser compatibility

{{CompatibilityTable}}

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support {{CompatNo}} {{CompatGeckoDesktop("1.9.1")}} {{CompatNo}} {{CompatNo}} {{CompatNo}}
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support {{CompatNo}} {{CompatGeckoMobile("1.9.1")}} {{CompatNo}} {{CompatNo}} {{CompatNo}}

See also

  • The {{domxref("Event")}} base interface.

Revision Source

<p>{{eventref("Event")}}</p>
<p>The <strong><code>ProgressEvent</code></strong> interface represents events measuring progress of an underlying processus, like an HTTP request (for an <code>XmlHTTPRequest</code>, or the loading of the underlying resource of an {{HTMLElement("img")}}, {{HTMLElement("audio")}}, {{HTMLElement("video")}}, {{HTMLElement("style")}} or {{HTMLElement("link")}}).</p>
<h2 id="Properties">Properties</h2>
<p><em>Inherits properties from its parent {{domxref("Event")}}</em>.</p>
<dl>
  <dt>
    {{domxref("ProgressEvent.lengthComputable")}} {{readonlyInline}}</dt>
  <dd>
    Is a {{domxref("Boolean")}} flag indicating if the total work to be done, and the amount of work already done, by the underlying processus is calculable. In other words, it tells if the progress is measurable or not.</dd>
  <dt>
    {{domxref("ProgressEvent.loaded")}} {{readonlyInline}}</dt>
  <dd>
    Is an <code>unsigned long long</code> representing the amount of work already performed by the underlying processus. The ratio of work done can be calculated with the property and <code>ProgressEvent.total</code>.</dd>
  <dt>
    {{domxref("ProgressEvent.total")}} {{readonlyInline}}</dt>
  <dd>
    Is an <code>unsigned long long</code> representing the total amount of work that the underlying processus is in the progress of performing.</dd>
</dl>
<h2 id="Constructor">Constructor</h2>
<dl>
  <dt>
    {{domxref("ProgressEvent.ProgressEvent", "ProgressEvent()")}}</dt>
  <dd>
    Creates a <code>ProgressEvent</code> event with the given parameters.</dd>
</dl>
<h2 id="Methods">Methods</h2>
<p><em>No specific method; inherits methods <em>from its parent {{domxref("Event")}}.</em></em></p>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
  <tbody>
    <tr>
      <th scope="col">Specification</th>
      <th scope="col">Status</th>
      <th scope="col">Comment</th>
    </tr>
    <tr>
      <td>{{SpecName('Progress Events', '#interface-progressevent', 'ProgressEvent')}}</td>
      <td>{{Spec2('Progress Events')}}</td>
      <td>Initial definition.</td>
    </tr>
  </tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{CompatibilityTable}}</p>
<div id="compat-desktop">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Chrome</th>
        <th>Firefox (Gecko)</th>
        <th>Internet Explorer</th>
        <th>Opera</th>
        <th>Safari</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatGeckoDesktop("1.9.1")}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatNo}}</td>
      </tr>
    </tbody>
  </table>
</div>
<div id="compat-mobile">
  <table class="compat-table">
    <tbody>
      <tr>
        <th>Feature</th>
        <th>Android</th>
        <th>Firefox Mobile (Gecko)</th>
        <th>IE Mobile</th>
        <th>Opera Mobile</th>
        <th>Safari Mobile</th>
      </tr>
      <tr>
        <td>Basic support</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatGeckoMobile("1.9.1")}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatNo}}</td>
        <td>{{CompatNo}}</td>
      </tr>
    </tbody>
  </table>
</div>
<h2 id="See_also">See also</h2>
<ul>
  <li>The {{domxref("Event")}} base interface.</li>
</ul>
Revert to this revision