API Documentation for: 0.6.0
Show:

ProgressEvent Class

Defined in: ProgressEvent:41
Module: PreloadJS

A createjs Event that is dispatched when progress changes.

Constructor

ProgressEvent

(
  • loaded
  • [total]
)

Defined in ProgressEvent:41

Parameters:

  • loaded Number

    The amount that has been loaded. This can be any number relative to the total.

  • [total] Number optional

    The total amount that will load. This will default to 0, so does not need to be passed in, as long as the loaded value is a progress value (between 0 and 1).

Item Index

Methods

Properties

Methods

clone

() ProgressEvent

Defined in clone:79

Returns a clone of the ProgressEvent instance.

Returns:

ProgressEvent:

a clone of the Event instance.

Properties

loaded

Number

Defined in loaded:53

The amount that has been loaded (out of a total amount)

progress

Number

Defined in progress:68

The percentage (out of 1) that the load has been completed. This is calculated using loaded/total.

Default: 0

total

Number

Defined in total:60

The total "size" of the load.

Default: 1