Documentation - aviable parameters
| Parameter | Possible values | Description |
|---|---|---|
| path | - | The path to the folder you would like to save the files to. End's with '/' |
| startOn | auto manually onSubmit:formId |
If set to auto, files will be uploaded on select. If set to manually, files will be uploaded after click on upload button. If set to onSubmit, files will be uploaded when the form with given id (after ':') will be submited. |
| ajax | true false |
Can be used only, if startOn is set to onSubmit:formId. When ajax is set to true, form data will be send via ajax to script specified in form action parameter, using method (post or get) specified in form method parameter. |
| ajaxInfoId | - | Can be used only, if ajax is set to true. Specified html node id where information outputted by script specified in form action parameter will be placed. So for example if you place in your php script (which submitted form) echo $message; the message will be placed in html node with ajaxInfoId id parameter. |
| ajaxLoaderId | - |
Can be used only, if ajax is set to true. Specified html node id which contains loader graphic. This node will be show before sending ajax request and will be hidden after getting response. Sample loader node can look like this:
<span class="imu_loader" id="loader"> <img src='ajax-loader.gif'/> </span> To make it work use ajaxLoaderId='loader' |
| buttonCaption | - | Upload button caption. Specify just if you use startOn="manually" |
| multi | true false |
true - multiple file uploads, false - one file upload |
| afterUpload | image link filename custom text |
Specified what's appears after upload. image - preview of uploaded file will be displayed, link - link to the uploaded file will be displayed, filename - the name of the uploaded file will be displayed, custom text - your custom text will be displayed (for example afterUpload="Upload complete!") If you specify custom text, you can use predefined variables to display some statistics:
|
| thumbnails | - | Dimension or dimensions of thumbnails that will be generated (in pixels). For example if you want to generate a 90x90 thumbnail use thumbnails="90x90". If you want to generate 3 thumbnails (first - 90x90, second - width 100px, heigth - keep aspect ratio, third - height 200px, width - keep aspect ratio) use thumbnails="90x90,100x,x200". |
| thumbnailsFolders | - | Paths to folders, where generated thumbnails will be placed. If you not specify this attribute, thumbnails will be placed in upload directory (specified by path parameter). If you specified for example 2 paths and you will generate 3 thumbnails, the first 2 thumbnails will be placed in specified foledrs, third thumbnail will be placed in upload folder (specified by path parameter). Notice: Thumbnails will be created with predefinied names (you can change them in upload.php file). First thumbnail will get thumb0_filename name, second will get thumb1_filename etc. |
| thumbnailsCrop | true false |
If set to true, thumbnail will be cropped instead of resized. It uses dimensions specified in thumbnails parameter(if thumbnails parameter isn't added, then nothing happens). For example if you want to crop a 90x90 thumbnail use thumbnails="90x90" thumbnailsCrop="true".If you want to generate 3 cropped thumbnails (first - 90x90, second - width 100px, heigth - keep old height, third - height 200px, width - keep old width) use thumbnails="90x90,100x,x200" thumbnailsCrop="true,true,true". |
| fileType | - | The type of files allowed for upload. This is taken from the file’s mime type. For example 'image/png'. To allow all files, set this value to false. To accept a set of files with different MIME types, separate each with a comma ',' character, example: image/png,image/jpeg,image/gif. For a complete list of MIME types, please visit Media Types at iana.org. |
| thumbnailsAfterUpload | image link filename custom text |
Specified what's appears after thumbnails generation. image - preview of thumbnail will be displayed, link - link to the thumbnail will be displayed, filename - the name of the thumbnail will be displayed, custom text - your custom text will be displayed. This parameter should be used like thumbnails parameter, for example (for 3 thumbnails) thumbnailsAfterUpload="link,image,Thumbnail created!". If you're not gonna specify this parameter, the thumbnails information/image will not be displayed. |
| maxSize | - | The maximum upload file size in kilo bytes (KB). Possible units: KB, MB, GB. When using without unit, then KB will be applied. |
| buttonClass | - | Custom css class to add for a button. |
| bwidth | - | Custom upload button width in pixels. |
| bheight | - | Custom upload button height in pixels. |
| buttonText | - | Caption of browse files button. |
| queueId | - | The id of the custom upload queue. You can use your own upload queue, rather than default queue. Just create own queue and specify it's id. The files will be show in your custom queue. |
| data | - | Custom data, that will be send to upload.php script. Data can be in json format or can contain jQuery dom element selectors from which value will be taken. For example data="'variable1':'value1', 'variable2':'value2', 'formInput':'selector:[name=firstInput]', 'otherInput':'selector:#someId'". WATERMARKS: Watermarks configuration should be passed through data parameter. Example 1 - two image watermarks (first image1.jpg distant 10px from bottom and 5px from right, second image2.jpg distant 0px from bottom and 20px from right): data="'watermark_path0':'image1.jpg','watermark_bottom0':'10','watermark_right0':'5', 'watermark_path1':'image2.jpg','watermark_bottom1':'0','watermark_right1':'20'" Example 2 - one text watermark (text - "sample text", width - 100%, height - 40px, background color - #000000, text color - #ffffff, background transparency - 60%, text transparency - 0%, font - arial.ttf, font size - 14px, text distant from left - 10px, text distant from top - 25px, background distant from bottom - 0px, background distant from right - 0px): data="'text_watermark_text0':'sample text','text_watermark_width0':'100p', 'text_watermark_height0':'40','text_watermark_background_color0':'#000000', 'text_watermark_text_color0':'#ffffff','text_watermark_bg_transparency0':'60', 'text_watermark_text_transparency0':'0','text_watermark_font0':'arial.ttf', 'text_watermark_font_size0':'14','text_watermark_text_x0':'10', 'text_watermark_text_y0':'25','text_watermark_right0':'0','text_watermark_bottom0':'0'" You can also use 2 additional parameters: -watermark_thumbnails, -text_watermark_thumbnails Above parameters decides if watermarks should be applied also to thumbnails (if you will create any). Example 3 data="'watermark_path0':'image1.jpg','watermark_bottom0':'10','watermark_right0':'5', 'watermark_path1':'image2.jpg','watermark_bottom1':'0','watermark_right1':'20', 'watermark_thumbnails':'1'" |
| method | post get |
Specified the method used to send data to upload script. |
| filesLimit | - | Number value of maximum files that can be selected to upload. |
| allowRemove | true false |
true - user can remove file after upload, false - user can't remove file after upload. Notice:If you set this parameter to true and using custom value of path parameter (different than "files/"), you've got to change default "files" folder value in upload.php file (lines 59, 60, 62) to your custom folder name/path. |
| removeData | - | Custom data, that will be send using POST method to upload.php script, when user click on remove button (available when parameter allowRemove is set to true). Data can be in json format or can contain jQuery dom element selectors from which value will be taken. For example: removeData="'variable1':'value1', 'variable2':'value2', 'formInput':'selector:[name=firstInput]', 'otherInput':'selector:#someId'". |
| sessionId | - | If you want to use session in upload.php scirpt, you've got to specify this parameter. For example sessionId="". (Check how_to_pass_session.html source.) |
| uploadScript | - | The path to upload script. By default is set to upload.php. |