WebUploader API文档.doc

Toggle navigation WebUploader
Getting started
Document
API
Demo
Download
FAQ
Github
WebUploader API文档
Web Uploader内部类的详细说明,以下提及的功能类,都可以在WebUploader这个变量中访问到。
As you know, Web Uploader的每个文件都是用过AMD规范中的define组织起来的, 每个Module都会有个module id. 默认module id为该文件的路径,而此路径将会转化成名字空间存放在WebUploader中。如:
module base:
module file:
module lib/dnd:
module runtime/html5/dnd:
以下文档中对类的使用可能省略掉了WebUploader前缀。
Uploader
options
events
option
getStats
destroy
addButton
makeThumb
md5File
addFiles
removeFile
getFiles
retry
sort
reset
predictRuntimeType
upload
stop
cancelFile
isInProgress
skipFile
request


Base
create
version
$
browser
os
inherits
noop
bindFn
log
slice
guid
formatSize
Deferred
isPromise
when
Mediator
on
once
off
trigger
installTo
File
events
name
size
type
lastModifiedDate
id
ext
statusText
setStatus
Status
Queue
stats
append
prepend
getFile
fetch
sort
getFiles
removeFile
Uploader
new Uploader( opts ) ⇒ Uploader
上传入口类。
var uploader = ({
swf: 'path_of_swf/',
// 开起分片上传。
chunked: true
});
参数说明
dnd {Selector} [可选] [默认值:undefined]
指定Drag And Drop拖拽的容器,如果不指定,则不启动。
disableGlobalDnd {Selector} [可选] [默认值:false]
是否禁掉整个页面的拖拽功能,如果不禁用,图片拖进来的时候会默认被浏览器打开。
paste {Selector} [可选] [默认值:undefined]
指定监听paste事件的容器,如果不指定,不启用此功能。此功能为通过粘贴来添加截屏的图片。.
pick {Selector, Object} [可选] [默认值:undefined]
指定选择文件的按钮容器,不指定则不创建按钮。
id {Seletor|dom} 指定选择文件的按钮容器,不指定则不创建按钮。注意这里虽然写的是 id, 但是不是只支持 id, 还支持 class, 或者 dom 节点。
label {String} 请采用 innerHTML 代替
innerHTML {String} 指定按钮文字。不指定时优先从指定的容器中看是否自带文字。
multiple {Boolean} 是否开起同时选择多个文件能力。
accept {Arroy} [可选] [默认值:null]
指定接受哪些类型的文件。由于目前还有ext转mimeType表,所以这里需要分开指定。
title {String} 文字描述
extensions {String} 允许的文件后缀,不带点,多个用逗号分割。
mimeTypes {String} 多个用逗号分割。
如:
{
title: 'Images',
extensions: 'gif,jpg,