Skip to content

前端导出

例子

TIP

业务中,如果需要前端做表单导出,就可以使用这个组件,它会根据分页情况,获取全部的数据并导出成为excel文件。 导出组件在运行时,会先查询一次limit=1的请求,为了获取total数据,然后进行每页数据的获取

Attributes 属性

属性类型说明默认值
columnsArrayArray<{title:string,key:string,width:number,formatter?:Function}>[],必须填写,不然导出表格是空的
columnWidthNumber默认的列宽10
exportButtonPropsObject导出按钮的props,直接传递给el-button{type: 'primary',size: 'mini',icon: 'el-icon-download'}
exportButtonTextString导出按钮文本导出
disabledBoolean是否禁用false
fileNameString导出文件名字无,不填写的话,会用时间戳作为名字
useExternalDataBoolean是否使用传入数据,而不是接口获取false
excelDataArray传入的数据,搭配useExternalData使用[]
queryApiFunction查询接口方法
queryIntervalNumber查询接口间隔毫秒数1000
processQueryDataFunc查询后可以用它来处理数据
specifyTotalNumber手动指定total,如果有些接口是无法给total的,可以手动指定导出总数,设置>=0生效-1
queryParamsObject发送给queryApi的额外参数{}
pageModeString分页模式,有page和limit两种从配置search.mode上获取
pageSizeKeyString分页尺寸的key从配置search.pageSize上获取
pageNumberKeyString分页数字的key从配置search.pageNo上获取
offsetKeyString当pageMode=limit时,偏移值的key从配置search.offset上获取
limitKeyString当pageMode=limit时,分页尺寸的key从配置search.limit上获取
dataPathString从response上获取的数据路径,支持.分割从配置response.data上获取
totalPathString从response上获取的total路径,支持.分割从配置response.total上获取
splitCountNumber分页查询,每页的数据量100
splitFileCountNumber每多少条分割一次文件10000
fileModeStringauto=根据splitFileCount分割文件,直接下载;zip=根据splitFileCount 分割文件,然后打包成zip;full=不分割文件,直接下载auto
xlsxPropsObject传递给底层xlsx库的参数,用来实现合并单元格等高级功能
beforeActionFunction执行导出功能前的方法,会等待这个方法完成
beforeCreateExcelFunction、AsyncFunction创建excel前的方法,会把整体的数据放出来,你也可以再这里修改options的内容,支持异步
delParamsEmptyBoolean是否删除查询空参数true

Events 事件

事件说明参数
clickExport点击导出按钮的时候触发
success导出完成
error导出错误

Released under the MIT License.