API
Component

ExportExcel ($UI/system/components/justep/excel/exportExcel)

使用范围：UI2

Contents

component ExportExcel ($UI/system/components/justep/excel/exportExcel) extends BindComponent

<b>将数据集数据导出</b> ## <b>文档链接</b>：#http://docs.newdao.net/zhuo-mian-biao-dan-zu-jian/exceldao-516526-excel-dao-chu.html#

Constructor Top

  ExportExcel ()
  ExportExcel ( options)

Properties Top

action = exportExcel

指定导出excel的action
data

导出的Data xid，导出excel的数据来源，目前只支持bizData
downloadFilename = download.xls

导出的文件名
exportCalculate = false

是否允许导出前端计算列，from='UI'时有效
exportKey = false

是否导出主键
from = DB

导出的数据来源方式，取值范围:"UI"/"DB"，
useConfigDlg

Attributes Top

action = exportExcel

指定导出excel的action
data

导出的Data xid，导出excel的数据来源，目前只支持bizData
downloadFilename = download.xls

导出的文件名
exportCalculate = false

是否允许导出前端计算列，from='UI'时有效
exportKey = false

是否导出主键
from = DB

导出的数据来源方式，取值范围:"UI"/"DB"，
relations

导出列，格式(列:宽)
useConfigDlg
xid

xid标识

Methods Top

void exportExcel ()
Object get (String name)
string getActivity ()
Data getData ()
string getProcess ()
void set (json arg)

Operations Top

void exportExcel ()

Events Top

boolean onBeforeExport (BeforeEvent event)
void onError (ErrorEvent event)
void onExportCreateParam (ExportCreateParam event)
void onSuccess (ViewEvent event)

Constructor details Top

public ExportExcel ()

<b>将数据集数据导出</b> ## <b>文档链接</b>：#http://docs.newdao.net/zhuo-mian-biao-dan-zu-jian/exceldao-516526-excel-dao-chu.html#

public ExportExcel ( options)

构造函数

Inherited from ViewComponent

	
		参数options格式类似{parent:xx, config:{}}，parent是组件的父节点，允许为空或不指定，config是组件的参数选项

Parameters

options

参数选项

Properties Detail Top

public action = exportExcel

指定导出excel的action

public data

导出的Data xid，导出excel的数据来源，目前只支持bizData

public downloadFilename = download.xls

导出的文件名

public exportCalculate = false

是否允许导出前端计算列，from='UI'时有效

public exportKey = false

是否导出主键

public from = DB

导出的数据来源方式，取值范围:"UI"/"DB"，

 
	UI：取当前data加载的数据导出；
	DB：使用data关联的queryAction查询数据导出，data的filter会施加到queryAction，但是不受limit、offset参数影响

public useConfigDlg

Attributes Detail Top

public action = exportExcel

指定导出excel的action

public data

导出的Data xid，导出excel的数据来源，目前只支持bizData

public downloadFilename = download.xls

导出的文件名

public exportCalculate = false

是否允许导出前端计算列，from='UI'时有效

public exportKey = false

是否导出主键

public from = DB

导出的数据来源方式，取值范围:"UI"/"DB"，

 
	UI：取当前data加载的数据导出；
	DB：使用data关联的queryAction查询数据导出，data的filter会施加到queryAction，但是不受limit、offset参数影响

public relations

导出列，格式(列:宽)

	为空时导出data的所有列
	导出的列名受“运行时导出参数配置框”中标题列名和relation的label属性影响，默认使用relation的label
	格式：
	列:宽,列:宽,...
	如：
	sName:300,sLock:400

public useConfigDlg

public xid

xid标识

Methods Detail Top

public void exportExcel ()

导出excel

	this.comp("excelExport1").exportExcel();

Return Value

void

public Object get (String name)

获取属性值

Parameters

String name

属性名称，取值范围："data"、"from"、"action"、"downloadFilename"、"exportKey"、"exportCalculate"、"useConfigDlg"

Return Value

Object

public string getActivity ()

获取导出动作使用的Activity

Return Value

string

public Data getData ()

获取导出的data对象

Return Value

Data

public string getProcess ()

获取导出动作使用的Process

Return Value

string

public void set (json arg)

设置属性值

Parameters

json arg

属性值对
结构如下：

{ "data" : {string} data xid， "from: {string} 导出的数据来源方式，取值范围:"UI"/"DB" "action: {string} 指定导出excel的action "downloadFilename: {string} 导出的文件名 "exportKey: {boolean} 是否导出主键 "exportCalculate: {boolean} 是否允许导出前端计算列，from='UI'时有效 "useConfigDlg: {boolean} 是否导出主键 }

Return Value

void

Operations Detail Top

public void exportExcel ()

导出Excel

Return Value

void

Events Detail Top

public boolean onBeforeExport (BeforeEvent event)

[回调型事件]导出前

Parameters

BeforeEvent event


参数结构如下：

{ "source" : 组件的js对象 "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 "cancel" : 取消导出 }

Return Value

boolean

控制 导出动作是否继续

public void onError (ErrorEvent event)

[回调型事件]导出失败

Parameters

ErrorEvent event


参数结构如下：

{ "source" : 组件的js对象, "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 "message" : 导出错误信息, "result" : http请求返回 }

Return Value

void

public void onExportCreateParam (ExportCreateParam event)

[回调型事件]创建导出参数

Parameters

ExportCreateParam event


参数结构如下：

{ "source" : 组件的js对象, "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 "param" : {Request.ActionParam} 导出参数对象 }

Return Value

void

public void onSuccess (ViewEvent event)

[回调型事件]导出成功

Parameters

ViewEvent event


参数结构如下：

{ "source" : 组件的js对象 "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 }

Return Value

void