cmp.att 类

附件部分的上传,下载,查看,编辑等
! 附件类只支持在cmp壳里面

方法

download

download
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:30

附件下载

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
url String 必选

附件的下载地址(默认:"")

[title] String 可选

在下载进度中的显示名称(默认:"")

[extData] Object 可选

额外参数，用于优化方面的需求的配置(目前可以配置的是文件本地缓存，避免同一个文件重复被下载)

名称类型标识描述
[fileId] String 可选
用于本地缓存的附件唯一ID
[lastModified] String 可选
用于本地缓存的附件唯一更新时间
[origin] String 可选
用于本地缓存的附件唯一的服务器地址，如：http://10.5.6.7:8080
[success] Function 可选

下载成功后的回调,附件成功下载到本地后的文件地址,文件名称,文件大小等信息返回

[error] Function 可选

下载错误的回调

[progress] Function 可选

下载进度的回调

示例:

<script>
    cmp.att.download({
         url:"",
         title:"",
         extData:{
              fileId:id,
              lastModified:lastModified,
              origin: _.origin
         }
         progress:function(result){
             //do something with progress result
         },
         success:function(result){
             var localUrl = result.url,  //保存到本地的地址
                 localFilename=result.filename, //保存到本地的文件名
                 size=result.size //文件大小
                 ....
         }
         error:function(error){
             //do something with error obj
         }
    });
</script>

getDownLoadListInfo

getDownLoadListInfo
(
  • [options]
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:110

获取下载列表信息

参数:

名称类型标识描述
[options] Object 可选

配置参数

名称类型标识描述
[success] Function 可选

成功回调

[error] Function 可选

失败回调

getFileInfo

getFileInfo
(
  • [options]
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:128

根据路径读取文件信息

参数:

名称类型标识描述
[options] Object 可选

配置参数

名称类型标识描述
filepath Array 必选

可以传多个文件路径，返回的信息对应到相应的文件上

[success] Function 可选

成功回调

[error] Function 可选

失败回调

getOfflineFiles

getOfflineFiles
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:204

获取本地离线文件

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
[success] Function 可选

成功回调

[error] Function 可选

失败回调

示例:

<script>
    cmp.att.getOfflineFiles({
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

getUploadListInfo

getUploadListInfo
(
  • [options]
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:119

获取上传列表信息

参数:

名称类型标识描述
[options] Object 可选

配置参数

名称类型标识描述
[success] Function 可选

成功回调

[error] Function 可选

失败回调

init

init
(
  • selector
  • [atts]
  • [docs]
  • [options]
  • [options:callback]
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:341

V5附件类(直接渲染已经存在的附件)

参数:

名称类型标识描述
selector String 必选

容器选择器，定义于页面装载附件对象的容器

[atts] Object 可选

//附件数据

[docs] Object 可选
[options] Object 可选

附件操作配置参数

名称类型标识描述
[isShowDelete] Boolean 可选

是否显示删除按钮，删除按钮会绑定开发者自定义的删除事件，默认：true

[isDefault] Boolean 可选

是否显示默认的附件样式

[delCallback] Function 可选

删除附件的回调
[options:callback] Function 可选

关联文档协同查看走开发者自定义的回调函数

示例:

<script>
    cmp.att.init(
       selector:"#attsArea",
       atts://v5附件对象数据
       docs://v5文档对象数据
       {
          callback:function seeDoc(docData){
          },
          isShowDelete:true,
          isDefault:true,
          delCallback:function(data){
             //data:将要被删除的附件数据，回调给开发者，开发者自行操作
          }
       }
    );
</script>

initUpload

initUpload
(
  • selector
  • options
)
AttUpload

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:272

专门为V5封装的一套附件上传,下载,查看和关联文档的组件

参数:

名称类型标识描述
selector String 必选

组件显示的容器

options Object 必选

配置参数

名称类型标识描述
[showAuth] Number 可选

附件按钮显示权限

  • 1：只显示附件（包括：【拍照】、【语音】、【本地文件】、【本地图片】
  • 2：只显示【关联文档】
  • 其他数字:全部显示

[initData] Object 可选

初始附件数据

[initDocData] Object 可选

初始关联文档数据

[callback] Function 可选

选择数据后的回调

[delCallback] Function 可选

删除数据的回调

返回值:

AttUpload:

示例:

<script>
    cmp.att.initUpload("showAreaID",{
         showAuth:-1, //按钮显示权限
         initData:null, //初始附件数据
         initDocData:null, //初始关联文档数据
         callback:function(result){ //选择成功后的回调
             //do something
         },
         delCallback:function(result){ //删除数据时的回调
             //do something
         }
    });
</script>

officeEdit

officeEdit
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:248

office文件编辑

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
[path] Function 可选

文件地址

[filename] Function 可选

文件名称

[uploadPath] Function 可选

上传到服务器的地址

[callback] Function 可选

回调函数

示例:

<script>
    cmp.att.officeEdit({
             path:"",
             filename:"",
             uploadPath:"",
         callback:function(){
             //do something
         }
    });
</script>

openOfflineFilesModule

openOfflineFilesModule
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:226

打开离线文档模块

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
[success] Function 可选

成功回调

[error] Function 可选

失败回调

示例:

<script>
    cmp.att.openOfflineFilesModule({
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

read

read
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:138

查看附件内容,包括pdf,excel,word,jpeg...

参数:

名称类型标识描述
options Object 必选

附件查看配置参数

名称类型标识描述
path String 必选

附件查看的地址,可以是远程地址或者本地地址

filename String 必选

附件名称

[edit] Boolean 可选

是否可以进行编辑,默认:false(注:目前只支持office文档文件的修改编辑,且只能通过wps软件进行修改)

[extData] Object 可选

额外参数，用于优化方面的需求的配置(目前可以配置的是文件本地缓存，避免同一个文件重复被下载)

名称类型标识描述
[fileId] String 可选
用于本地缓存的附件唯一ID
[lastModified] String 可选
用于本地缓存的附件唯一更新时间
[origin] String 可选
用于本地缓存的附件唯一的服务器地址，如：http://10.5.6.7:8080
[success] Function 可选

成功回调

[error] Function 可选

失败回调

示例:

<script>
    cmp.att.read({
         path:"",  //附件查看的地址
         filename:"",//附件名称
         edit:false,  //是否可以进行修改编辑
         extData:{
              fileId:id,
              lastModified:lastModified,
              origin: _.origin
         }
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

saveBase64

saveBase64
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:176

保存base64数据到本地

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
base64 String 必选

base64数据

filename String 必选

保存成文件的名称

type String 必选

保存成文件的类型

[success] Function 可选

保存成功回调

[error] Function 可选

保存失败回调

示例:

<script>
    cmp.att.saveBase64({
         base64:"",
         filename:"",//附件名称
         type:"png",
         success:function(result){
             //do something
         }
         error:function(error){
             //do something
         }
    });
</script>

suite

suite
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:307

附件组件套件（不涉及到ue）

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
type String 必选

调用的类型：

  • “photo”:照相
  • “picture”：本地图片
  • “accDoc”：关联文档
  • “voice”：录音
  • “localFile”:本地文件

[initDocData] String 可选

如果type是"accDoc",有初始关联文档值的话，需要传初始关联文档值

[success] Function 可选

成功回调

[error] Function 可选

失败回调

示例:

<script>
    cmp.att.suite({
         type:"photo",
         initDocData:null, //初始关联文档数据
         success:function(result){ //选择成功后的回调
             //do something
         },
         error:function(result){ //删除数据时的回调
             //do something
         }
    });
</script>

upload

upload
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-file-doc.js:72

附件上传（支持多文件上传）

参数:

名称类型标识描述
options Object 必选

附件上传配置参数

名称类型标识描述
url String 必选

附件提交到服务器的地址

fileList Array 必选

本地附件资源的路径集,其中单个file对象的格式为
{filepath:"文件路径",fileId:"文件唯一id"}

[extData] String 可选

扩展到业务数据,如对象ID,业务类型等,用JSon字符串转码后提交到服务器

[imgIndex] String 可选

多张文件上传的时候服务器端认证的顺序关键字段，默认sortNum

[progress] Function 可选

上传进度回调

[success] Function 可选

上传成功回调

[error] Function 可选

上传失败回调

示例:

<script>
    cmp.att.upload({
         url:"",  //附件上传的服务器地址
         fileList:"",//需要上传的附件列表
         title:"",  //上传进度显示名称
         extData:"",
         progress:function(result){
             var progressVal = result["pos"];  //0~1的小数，即上传进度的百分比
         },
         success:function(result){  //服务器端返回的相应数据
             var filename = result.filename,
                 url = result.url,
                 size = result.size
         }
         error:function(error){
             //do something
         }
    });
</script>
Top