The base loader, which defines all the generic methods, properties, and events. All loaders extend this class, including the LoadQueue.
_createRequest
Defined in
_createRequest:409
Create an internal request used for loading. By default, an XHRRequest or TagRequest is created, depending on the value of PreferXHR:property. Other loaders may override this to use different request types, such as ManifestLoader, which uses JSONLoader or JSONPLoader under the hood.
_createTagsrc
Defined in
_createTag:425
Create the HTML tag used for loading. This method does nothing by default, and needs to be implemented by loaders that require tag loading.
src
String
The tag source
The tag that was created
_isCanceled
Defined in
_isCanceled:503
Determine if the load has been canceled. This is important to ensure that method calls or asynchronous events do not cause issues after the queue has been cleaned up.
If the loader has been canceled.
_resultFormatSuccessresult
Defined in
_resultFormatSuccess:568
The "success" callback passed to AbstractLoader/resultFormatter asynchronous functions.
result
Object
The formatted result
_resultFormatSuccesserror
Defined in
_resultFormatSuccess:580
The "error" callback passed to AbstractLoader/resultFormatter asynchronous functions.
error
Object
The error event
_sendErrorevent
Defined in
_sendError:488
event
ErrorEvent
The event object containing specific error properties.
addEventListenertype
listener
[useCapture]
Inherited from
EventDispatcher:
addEventListener:140
Adds the specified event listener. Note that adding multiple listeners to the same function will result in multiple callbacks getting fired.
displayObject.addEventListener("click", handleClick);
function handleClick(event) {
// Click happened.
}type
String
The string type of the event.
listener
Function | Object
An object with a handleEvent method, or a function that will be called when the event is dispatched.
[useCapture]
Boolean
optional
For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.
cancel
Defined in
cancel:365
Close the the item. This will stop any open requests (although downloads using HTML tags may still continue in the background), but events will not longer be dispatched.
dispatchEventeventObj
[bubbles]
[cancelable]
Inherited from
EventDispatcher:
dispatchEvent:285
Dispatches the specified event to all listeners.
// Use a string event
this.dispatchEvent("complete");
// Use an Event instance
var event = new createjs.Event("progress");
this.dispatchEvent(event);eventObj
Object | String | Event
An object with a "type" property, or a string type. While a generic object will work, it is recommended to use a CreateJS Event instance. If a string is used, dispatchEvent will construct an Event instance if necessary with the specified type. This latter approach can be used to avoid event object instantiation for non-bubbling events that may not have any listeners.
[bubbles]
Boolean
optional
Specifies the bubbles value when a string was passed to eventObj.
[cancelable]
Boolean
optional
Specifies the cancelable value when a string was passed to eventObj.
Returns false if preventDefault() was called on a cancelable event, true otherwise.
getItem
Defined in
getItem:290
Available since 0.6.0
Get a reference to the manifest item that is loaded by this loader. In some cases this will be the value that was passed into LoadQueue using loadFile or loadManifest. However if only a String path was passed in, then it will be a LoadItem.
The manifest item that this loader is responsible for loading.
getLoadedItems
Defined in
getLoadedItems:396
Available since 0.6.0
Get any items loaded internally by the loader. The enables loaders such as ManifestLoader to expose items it loads internally.
A list of the items loaded by the loader.
getResult[raw=false]
Defined in
getResult:303
Available since 0.6.0
Get a reference to the content that was loaded by the loader (only available after the Complete:event event is dispatched.
[raw=false]
Boolean
optional
Determines if the returned result will be the formatted content, or the raw loaded data (if it exists).
getTag
Defined in
getTag:316
Available since 0.6.0
Return the tag this object creates or uses for loading.
The tag instance
handleEventevent
Defined in
handleEvent:525
Available since 0.6.0
Handle events from internal requests. By default, loaders will handle, and redispatch the necessary events, but this method can be overridden for custom behaviours.
event
Event
The event that the internal request dispatches.
hasEventListenertype
Inherited from
EventDispatcher:
hasEventListener:339
Indicates whether there is at least one listener for the specified event type.
type
String
The string type of the event.
Returns true if there is at least one listener for the specified event.
load
Defined in
load:336
Begin loading the item. This method is required when using a loader by itself.
var queue = new createjs.LoadQueue();
queue.on("complete", handleComplete);
queue.loadManifest(fileArray, false); // Note the 2nd argument that tells the queue not to start loading yet
queue.load();offtype
listener
[useCapture]
Inherited from
EventDispatcher:
off:249
A shortcut to the removeEventListener method, with the same parameters and return value. This is a companion to the .on method.
IMPORTANT: To remove a listener added with on, you must pass in the returned wrapper function as the listener. See
on for an example.
ontype
listener
[scope]
[once=false]
[data]
[useCapture=false]
Inherited from
EventDispatcher:
on:173
A shortcut method for using addEventListener that makes it easier to specify an execution scope, have a listener only run once, associate arbitrary data with the listener, and remove the listener.
This method works by creating an anonymous wrapper function and subscribing it with addEventListener.
The wrapper function is returned for use with removeEventListener (or off).
IMPORTANT: To remove a listener added with on, you must pass in the returned wrapper function as the listener, or use
remove. Likewise, each time you call on a NEW wrapper function is subscribed, so multiple calls
to on with the same params will create multiple listeners.
var listener = myBtn.on("click", handleClick, null, false, {count:3});
function handleClick(evt, data) {
data.count -= 1;
console.log(this == myBtn); // true - scope defaults to the dispatcher
if (data.count == 0) {
alert("clicked 3 times!");
myBtn.off("click", listener);
// alternately: evt.remove();
}
}type
String
The string type of the event.
listener
Function | Object
An object with a handleEvent method, or a function that will be called when the event is dispatched.
[scope]
Object
optional
The scope to execute the listener in. Defaults to the dispatcher/currentTarget for function listeners, and to the listener itself for object listeners (ie. using handleEvent).
[once=false]
Boolean
optional
If true, the listener will remove itself after the first time it is triggered.
[data]
optional
Arbitrary data that will be included as the second parameter when the listener is called.
[useCapture=false]
Boolean
optional
For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.
Returns the anonymous function that was created and assigned as the listener. This is needed to remove the listener later using .removeEventListener.
removeAllEventListeners[type]
Inherited from
EventDispatcher:
removeAllEventListeners:263
Removes all listeners for the specified type, or all listeners of all types.
// Remove all listeners
displayObject.removeAllEventListeners();
// Remove all click listeners
displayObject.removeAllEventListeners("click");[type]
String
optional
The string type of the event. If omitted, all listeners for all types will be removed.
removeEventListenertype
listener
[useCapture]
Inherited from
EventDispatcher:
removeEventListener:219
Removes the specified event listener.
Important Note: that you must pass the exact function reference used when the event was added. If a proxy function, or function closure is used as the callback, the proxy/closure reference must be used - a new proxy or closure will not work.
displayObject.removeEventListener("click", handleClick);setTagtag
Defined in
setTag:326
Available since 0.6.0
Set the tag this item uses for loading.
tag
Object
The tag instance
toStringInherited from
EventDispatcher
but overwritten in
toString:591
a string representation of the instance.
willTriggertype
Inherited from
EventDispatcher:
willTrigger:350
Indicates whether there is at least one listener for the specified event type on this object or any of its ancestors (parent, parent's parent, etc). A return value of true indicates that if a bubbling event of the specified type is dispatched from this object, it will trigger at least one listener.
This is similar to hasEventListener, but it searches the entire event flow for a listener, not just this object.
type
String
The string type of the event.
Returns true if there is at least one listener for the specified event.
_item
Defined in
_item:127
The LoadItem this loader represents. Note that this is null in a LoadQueue, but will be available on loaders such as XMLLoader and ImageLoader.
_loadItems
Defined in
_loadItems:167
A list of items that loaders load behind the scenes. This does not include the main item the loader is responsible for loading. Examples of loaders that have sub-items include the SpriteSheetLoader and ManifestLoader.
_preferXHR
Defined in
_preferXHR:140
Whether the loader will try and load content using XHR (true) or HTML tags (false).
_rawResult
Defined in
_rawResult:158
The loaded result before it is formatted. The rawResult is accessed using the GetResult
method, and passing true.
_result
Defined in
_result:148
The loaded result after it is formatted by an optional ResultFormatter. For items that are not formatted, this will be the same as the _rawResult:property. The result is accessed using the GetResult method.
_tag
Defined in
_tag:185
An HTML tag (or similar) that a loader may use to load HTML content, such as images, scripts, etc.
canceled
Defined in
canceled:66
Determine if the loader was canceled. Canceled loads will not fire complete events. Note that this property is readonly, so LoadQueue queues should be closed using close instead.
Default: false
loaded
Defined in
loaded:57
If the loader has completed loading. This provides a quick check, but also ensures that the different approaches
used for loading do not pile up resulting in more than one complete Event.
Default: false
progress
Defined in
progress:77
The current load progress (percentage) for this item. This will be a number between 0 and 1.
var queue = new createjs.LoadQueue();
queue.loadFile("largeImage.png");
queue.on("progress", function() {
console.log("Progress:", queue.progress, event.progress);
});Default: 0
resultFormatter
Defined in
resultFormatter:102
A formatter function that converts the loaded raw result into the final result. For example, the JSONLoader converts a string of text into a JavaScript object. Not all loaders have a resultFormatter, and this property can be overridden to provide custom formatting.
Optionally, a resultFormatter can return a callback function in cases where the formatting needs to be asynchronous, such as creating a new image. The callback function is passed 2 parameters, which are callbacks to handle success and error conditions in the resultFormatter. Note that the resultFormatter method is called in the current scope, as well as the success and error callbacks.
function _formatResult(loader) {
return function(success, error) {
if (errorCondition) { error(errorDetailEvent); }
success(result);
}
}Default: null
resultFormatter
Defined in
resultFormatter:514
Available since 0.6.0
A custom result formatter function, which is called just before a request dispatches its complete event. Most
loader types already have an internal formatter, but this can be user-overridden for custom formatting. The
formatted result will be available on Loaders using GetResult, and passing true.
type
Defined in
type:94
The type of item this loader will load. See AbstractLoader for a full list of supported types.
complete
Defined in
complete:237
Available since 0.3.0
The Event that is fired when the entire queue has been loaded.
error
Defined in
error:245
Available since 0.3.0
The ErrorEvent that is fired when the loader encounters an error. If the error was encountered by a file, the event will contain the item that caused the error. Prior to version 0.6.0, this was just a regular Event.
fileerror
Defined in
fileerror:253
Available since 0.6.0
The Event that is fired when the loader encounters an internal file load error. This enables loaders to maintain internal queues, and surface file load errors.
fileload
Defined in
fileload:263
Available since 0.6.0
The Event that is fired when a loader internally loads a file. This enables loaders such as ManifestLoader to maintain internal LoadQueues and notify when they have loaded a file. The LoadQueue class dispatches a slightly different fileload event.
target
Object
The object that dispatched the event.
type
String
The event type ("fileload")
item
Object
The file item which was specified in the loadFile
or loadManifest call. If only a string path or tag was specified, the
object will contain that value as a src property.
result
Object
The HTML tag or parsed result of the loaded item.
rawResult
Object
The unprocessed result, usually the raw text or binary data before it is converted to a usable object.
initialize
Defined in
initialize:280
The Event that is fired after the internal request is created, but before a load. This allows updates to the loader for specific loading needs, such as binary or XHR image loading.
target
Object
The object that dispatched the event.
type
String
The event type ("initialize")
loader
AbstractLoader
The loader that has been initialized.
loadstart
Defined in
loadstart:229
Available since 0.3.1
The Event that is fired when a load starts.
progress
Defined in
progress:222
Available since 0.3.0
The ProgressEvent that is fired when the overall progress changes. Prior to version 0.6.0, this was just a regular Event.