Skip to content

Uploader

Jump to bottom Edit New page
Joris edited this page Jan 18, 2015 · 21 revisions

Table of Contents

Constructor

### [Uploader(settings)](/moxiecode/plupload/blob/master/src/plupload.js#L697 "Defined at: src/plupload.js:697")

Arguments

  • settings Object
    For detailed information about each option check documentation.
    • browse_button String|DOMElement
      id of the DOM element or DOM element itself to use as file dialog trigger.
    • url String
      URL of the server-side upload handler.
    • [chunk_size=0] Number|String
      Chunk size in bytes to slice the file into. Shorcuts with b, kb, mb, gb, tb suffixes also supported. e.g. 204800 or "204800b" or "200kb". By default - disabled.
    • [container] String
      id of the DOM element to use as a container for uploader structures. Defaults to document.body.
    • [drop_element] String|DOMElement
      id of the DOM element or DOM element itself to use as a drop zone for Drag-n-Drop.
    • [file_data_name="file"] String
      Name for the file field in Multipart formated message.
    • [filters={}] Object
      Set of file type filters.
      • [mime_types=[] Array
        List of file types to accept, each one defined by title and list of extensions. e.g. {title : "Image files", extensions : "jpg,jpeg,gif,png"}. Dispatches plupload.FILE_EXTENSION_ERROR
      • [max_file_size=0] String|Number
        Maximum file size that the user can pick, in bytes. Optionally supports b, kb, mb, gb, tb suffixes. e.g. "10mb" or "1gb". By default - not set. Dispatches plupload.FILE_SIZE_ERROR.
      • [prevent_duplicates=false] Boolean
        Do not let duplicates into the queue. Dispatches plupload.FILE_DUPLICATE_ERROR.
    • [flash_swf_url] String
      URL of the Flash swf.
    • [headers] Object
      Custom headers to send with the upload. Hash of name/value pairs.
    • [max_retries=0] Number
      How many times to retry the chunk or file, before triggering Error event.
    • [multipart=true] Boolean
      Whether to send file and additional parameters as Multipart formated message.
    • [multipart_params] Object
      Hash of key/value pairs to send with every file upload.
    • [multi_selection=true] Boolean
      Enable ability to select multiple files at once in file dialog.
    • [required_features] String|Object
      Either comma-separated list or hash of required features that chosen runtime should absolutely possess.
    • [resize] Object
      Enable resizng of images on client-side. Applies to image/jpeg and image/png only. e.g. {width : 200, height : 200, quality : 90, crop: true}
      • [width] Number
        If image is bigger, it will be resized.
      • [height] Number
        If image is bigger, it will be resized.
      • [quality=90] Number
        Compression quality for jpegs (1-100).
      • [crop=false] Boolean
        Whether to crop images to exact dimensions. By default they will be resized proportionally.
    • [runtimes="html5,flash,silverlight,html4"] String
      Comma separated list of runtimes, that Plupload will try in turn, moving to the next if previous fails.
    • [silverlight_xap_url] String
      URL of the Silverlight xap.
    • [unique_names=false] Boolean
      If true will generate unique filenames for uploaded files.
## Properties ### [id](/moxiecode/plupload/blob/master/src/plupload.js#L1612 "Defined at: src/plupload.js:1612")

Unique id for the Uploader instance.

### [state](/moxiecode/plupload/blob/master/src/plupload.js#L1621 "Defined at: src/plupload.js:1621")

Current state of the total uploading progress. This one can either be plupload.STARTED or plupload.STOPPED. These states are controlled by the stop/start methods. The default value is STOPPED.

### [features](/moxiecode/plupload/blob/master/src/plupload.js#L1630 "Defined at: src/plupload.js:1630")

Map of features that are available for the uploader runtime. Features will be filled before the init event is called, these features can then be used to alter the UI for the end user. Some of the current features that might be in this map is: dragdrop, chunks, jpgresize, pngresize.

### [runtime](/moxiecode/plupload/blob/master/src/plupload.js#L1640 "Defined at: src/plupload.js:1640")

Current runtime name.

### [files](/moxiecode/plupload/blob/master/src/plupload.js#L1648 "Defined at: src/plupload.js:1648")

Current upload queue, an array of File instances.

### [settings](/moxiecode/plupload/blob/master/src/plupload.js#L1657 "Defined at: src/plupload.js:1657")

Object with name/value settings.

### [total](/moxiecode/plupload/blob/master/src/plupload.js#L1665 "Defined at: src/plupload.js:1665")

Total progess information. How many files has been uploaded, total percent etc.

## Methods ### [init()](/moxiecode/plupload/blob/master/src/plupload.js#L1674 "Defined at: src/plupload.js:1674")

Initializes the Uploader instance and adds internal event listeners.

### [setOption(option, [value])](/moxiecode/plupload/blob/master/src/plupload.js#L1723 "Defined at: src/plupload.js:1723")

Set the value for the specified option(s).

Arguments

  • option String|Object
    Name of the option to change or the set of key/value pairs
  • [value] Mixed
    Value for the option (is ignored, if first argument is object)
### [getOption([option])](/moxiecode/plupload/blob/master/src/plupload.js#L1735 "Defined at: src/plupload.js:1735")

Get the value for the specified option or the whole configuration, if not specified.

Arguments

  • [option] String
    Name of the option to get
### [refresh()](/moxiecode/plupload/blob/master/src/plupload.js#L1750 "Defined at: src/plupload.js:1750")

Refreshes the upload instance by dispatching out a refresh event to all runtimes. This would for example reposition flash/silverlight shims on the page.

### [start()](/moxiecode/plupload/blob/master/src/plupload.js#L1765 "Defined at: src/plupload.js:1765")

Starts uploading the queued files.

### [stop()](/moxiecode/plupload/blob/master/src/plupload.js#L1779 "Defined at: src/plupload.js:1779")

Stops the upload of the queued files.

### [disableBrowse(disable)](/moxiecode/plupload/blob/master/src/plupload.js#L1793 "Defined at: src/plupload.js:1793")

Disables/enables browse button on request.

Arguments

  • disable Boolean
    Whether to disable or enable (default: true)
### [getFile(id)](/moxiecode/plupload/blob/master/src/plupload.js#L1811 "Defined at: src/plupload.js:1811")

Returns the specified file object by id.

Arguments

  • id String
    File id to look for.
### [addFile(file, [fileName])](/moxiecode/plupload/blob/master/src/plupload.js#L1827 "Defined at: src/plupload.js:1827")

Adds file to the queue programmatically. Can be native file, instance of Plupload.File, instance of mOxie.File, input[type="file"] element, or array of these. Fires FilesAdded, if any files were added to the queue. Otherwise nothing happens.

Arguments

  • file plupload.File|mOxie.File|File|Node|Array
    File or files to add to the queue.
  • [fileName] String
    If specified, will be used as a name for the file
### [removeFile(file)](/moxiecode/plupload/blob/master/src/plupload.js#L1928 "Defined at: src/plupload.js:1928")

Removes a specific file.

Arguments

  • file plupload.File|String
    File to remove from queue.
### [splice(start, length)](/moxiecode/plupload/blob/master/src/plupload.js#L1944 "Defined at: src/plupload.js:1944")

Removes part of the queue and returns the files removed. This will also trigger the FilesRemoved and QueueChanged events.

Arguments

  • start Number
    (Optional) Start index to remove from.
  • length Number
    (Optional) Lengh of items to remove.
### [trigger(name, Multiple)](/moxiecode/plupload/blob/master/src/plupload.js#L1980 "Defined at: src/plupload.js:1980")

Dispatches the specified event name and it's arguments to all listeners.

Arguments

  • name String
    Event name to fire.
  • Multiple Object..
    arguments to pass along to the listener functions.
### [hasEventListener(name)](/moxiecode/plupload/blob/master/src/plupload.js#L1989 "Defined at: src/plupload.js:1989")

Check whether uploader has any listeners to the specified event.

Arguments

  • name String
    Event name to check for.
### [bind(name, func, scope)](/moxiecode/plupload/blob/master/src/plupload.js#L1997 "Defined at: src/plupload.js:1997")

Adds an event listener by name.

Arguments

  • name String
    Event name to listen for.
  • func Function
    Function to call ones the event gets fired.
  • scope Object
    Optional scope to execute the specified function in.
### [unbind(name, func)](/moxiecode/plupload/blob/master/src/plupload.js#L2015 "Defined at: src/plupload.js:2015")

Removes the specified event listener.

Arguments

  • name String
    Name of event to remove.
  • func Function
    Function to remove from listener.
### [unbindAll()](/moxiecode/plupload/blob/master/src/plupload.js#L2023 "Defined at: src/plupload.js:2023")

Removes all event listeners.

### [destroy()](/moxiecode/plupload/blob/master/src/plupload.js#L2030 "Defined at: src/plupload.js:2030")

Destroys Plupload instance and cleans after itself.

## Events ### Init

Fires when the current RunTime has been initialized.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
### PostInit

Fires after the init event incase you need to perform actions there.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
### OptionChanged

Fires when the option is changed in via uploader.setOption().

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • name String Name of the option that was changed
  • value Mixed New value for the specified option
  • oldValue Mixed Previous value of the option
### Refresh

Fires when the silverlight/flash or other shim needs to move.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
### StateChanged

Fires when the overall state is being changed for the upload queue.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
### UploadFile

Fires when a file is to be uploaded by the runtime.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File File to be uploaded.
### BeforeUpload

Fires when just before a file is uploaded. This event enables you to override settings on the uploader instance before the file is uploaded.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File File to be uploaded.
### QueueChanged

Fires when the file queue is changed. In other words when files are added/removed to the files array of the uploader instance.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
### UploadProgress

Fires while a file is being uploaded. Use this event to update the current file upload progress.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File File that is currently being uploaded.
### FilesRemoved

Fires when file is removed from the queue.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • files plupload.File[] Array of files that got removed.
### FileFiltered

Fires for every filtered file before it is added to the queue.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File Another file that has to be added to the queue.
### FilesAdded

Fires after files were filtered and added to the queue.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • files plupload.File[] Array of file objects that were added to queue by the user
### FileUploaded

Fires when a file is successfully uploaded.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File File that was uploaded.
  • response Object
    • response String The response body sent by the server.
    • status Number The HTTP status code sent by the server.
    • responseHeaders String All the response headers as a single string.
### ChunkUploaded

Fires when file chunk is uploaded.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • file plupload.File File that the chunk was uploaded for.
  • response Object
    • offset Number The amount of bytes the server has received so far, including this chunk.
    • total Number The size of the file.
    • response String The response body sent by the server.
    • status Number The HTTP status code sent by the server.
    • responseHeaders String All the response headers as a single string.
### UploadComplete

Fires when all files in a queue are uploaded.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • files plupload.File[] Array of file objects that was added to queue/selected by the user.
### Error

Fires when a error occurs.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
  • error Object
    • code Number The plupload error code
    • message String An description of the error (uses internationalization)
    • file plupload.File The file that this errors belongs to. Some errors do not have this set.
    • response String The response body sent by the server. Some errors do not have this set.
    • status Number The HTTP status code sent by the server. Some errors do not have this set.
    • responseHeaders String All the response headers as a single string. Some errors do not have this set.
### Destroy

Fires when destroy method is called.

Arguments

  • uploader plupload.Uploader Uploader instance sending the event.
Add a custom footer

Table of Contents

Clone this wiki locally