数据导出
将数据从表、重复布局或复杂对象列表导出为 .xlsx 或 .csv 文件格式。
外观
| 颜色款式: | 此视图的颜色样式。 {Default | Primary | Info | Success | Warning | Danger | Dark} |
ButtonColorStyle |
| 外形风格: | 圆角、平面或正方形(缺省)视图形状。 {Default | Rounded | Flat} |
ButtonShapeStyle |
| 大小: | 此视图的基于尺寸的样式(默认、大、小、超小) {Default | Large | Small | Extra-Small} |
ButtonSizeStyle |
| 仅限轮廓: | 仅当悬停在视图上时显示其基于颜色的样式。 | Boolean |
| 图标: | 图标名称,例如:日历、时钟、摄像头、云上载、铃声、信息、文件文本等。 请查看 http://fontawesome.io/icons 以获取完整列表。 (请注意,“fa-”前缀是可选项) | String |
| 宽度: | 宽度(单位:px、%)或em.\r\nFor例子\: 50px,20%, 0.4em。 如果未指定任何单位,将采用 px。 | String |
行为
| 目标视图: | 用于填充输出文件的表或重复布局的相对路径。 如果该视图与数据绑定,那么将被覆盖。 | String |
| 导出文件类型: | 导出到的文件类型 {Microsoft Excel 2007+ file type xlsx | Comma Separated Values file type csv} |
ExcelFileType |
| 默认文件名: | 文件的缺省名称。 用户在保存时能够更改此名称。 | String |
| 包括列标题: | 如果将该视图绑定到表,并且“列标题”属性为空,那么将包含绑定表的列标题。 如果将该视图绑定到数据,那么“列标题”属性中的设置将用作列标题。 | Boolean |
| 标签索引: | 表单视图的跳进顺序索引。 索引从 1 开始,可以稀疏地设置。 例如,您可以使用 1、5、10。 | Integer |
| 包括隐藏列: | 包含所有列,而不管可视性状态如何。 缺省情况下,不可视的列将不包含在输出文件中。 当使用绑定数据填充视图时,将包含所有列 | Boolean |
| 列格式: | 所导出列的特定配置选项。 有关格式化字符串的更多详细信息,请访问以下网站(文档中的超链接):https\://support.office.com/en-us/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4 | ColumnSpec[] |
| 列标题: | 所导出列的标题。 需要选中“包含列标题”属性。 如果将该视图绑定到表,那么将使用这些标题而非表列标题。 | String[] |
| 列顺序: | 导出文件中的列显示顺序。 仅在将视图绑定到数据时,此选项才生效。 指定的值必须匹配绑定数据参数。 | String[] |
| 事件 | ||||||||||||||
| 在装入时: |
| |||||||||||||
| 点击时: |
| |||||||||||||
| 关于单元导出: |
| |||||||||||||
延伸:
Methods:
遗传添加类(姓名, [已替换])
添加/替换此控件的 CSS 类
| 名称 | Type | Default | 描述 |
| 名称 | {string} | 要添加到控件的 CSS 类名。 如果有多个类,则用空格分隔类名。 | |
| 已被替换 | {string} | 要由第一个参数替换的 CSS 类名。 如果有多个类,则用空格分隔类名。 |
示例
| Button.addClass("green"); |
点击()
以编程方式单击导出按钮
导出文件( [目标路径], [格式])
导出电子表格文件
| 名称 | Type | Default | 描述 |
| targetPath | {?(string|object)} | 目标控制的路径或控制视图引用。 如果为空或缺失,将默认为由{@link DataExport#getTargetControl} 。 | |
| 格式 | {?string} | 输出的文件格式。 可接受的值包括“xlsx”和“csv”。 如果为空或缺失,将默认为返回的格式{@link DataExport#getFileType} 。 |
示例
| ${DataExport1}.exportFile( ) // 使用当前设置的目标控制和文件格式参数导出电子表格 |
| $ {DataExport1} .exportFile(${Table3}) // 使用以下数据导出电子表格Table3 |
| $ {DataExport1} .exportFile(${Table3}, 'csv') // 使用来自的数据导出电子表格Table3采用 csv 格式,无论其他设置如何 |
重点()
将焦点置于此控件上
获取颜色样式()返回:
{string}获取导出按钮的颜色样式。 注意:这始终返回设置的颜色,为避免歧义,请始终使用“D”|“P”|“I”|“S”|“W”|“E”设置颜色
获取列格式()返回:
{string[]}获取当前列格式。 看{@link https://support.office.com/en-us/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4|Create or delete a custom number format}有关创建格式化字符串的更多信息。
获取列标题()返回:
{string[]}获取列标题。
获取文件名()返回:
{string}获取默认的输出文件名。 用户可以在保存时更改文件名。
获取文件类型()返回:
{string}获取当前设置的输出格式
获取帮助文本()返回:
{string}获取导出按钮的帮助文本
获取ShapeStyle ()返回:
{string}获取导出按钮的形状风格。 注意:这始终返回设置的形状样式,为避免歧义,请始终使用“D”|“R”|“F”设置形状样式
获取尺寸样式()返回:
{string}获取导出按钮的大小样式。 注意:这始终返回设置的尺寸样式,为避免歧义,请始终使用“D”|“S”|“L”|“X”设置尺寸样式
获取标签索引()返回:
{integer}获取标签索引DataExport控制
获取目标控制()返回:
{string}获取用于填充电子表格的控件的名称
获取文本()返回:
{string}获取导出按钮的文本
获取类型()返回:
{string}获取表示控件类型的描述字符串
获取宽度()返回:
{string}获取导出按钮的配置宽度(包括单位)
遗传隐藏(collapseFlag)
隐藏此视图/控件
| 名称 | Type | Default | 描述 |
| collapseFlag | {boolean} | 设置true折叠视图(相当于视图设置为“NONE”) |
示例
| MyView。隐藏(); |
遗传已绑定()返回:
{boolean}表示控件的绑定状态。
是否包含列名称()返回:
{boolean}返回输出文件中是否包含列名
遗传已启用()返回:
{boolean}检查视图是否已启用
示例
| 变量已启用 = MyView.isEnabled((英文): |
是否包含 InvisibleColumns ()返回:
{boolean}返回输出文件是否包含隐藏的列/字段
遗传标签是否可见()返回:
{boolean}检查控制标签是否可见
示例
| 变量labelVisible= MyView.isLabelVisible((英文): |
遗传是否可见()返回:
{boolean}检查视图是否可见
示例
| 变量可见= MyView.isVisible((英文): |
遗传propagateUpValueChange (事件)返回:
{boolean}通过父视图向上传播控制值的变化
| 名称 | Type | Default | 描述 |
| 事件 | {Event} | 值改变事件(通常是 onchange 事件) |
示例
| MyView.propagateUp(event); |
设置颜色样式(风格)
设置导出按钮的颜色样式。 注意:为避免歧义,请始终使用“D”|“P”|“I”|“S”|“W”|“E”设置颜色
| 名称 | Type | Default | 描述 |
| 样式 | {string} | “DEFAULT”|“DEF”|“D”=默认 | “PRIMARY”|“PRI”|“P”=主要 | “INFO”|INF“|“I”=信息 | “SUCCESS”|“S”=成功 | “WARNING”|“WARN”|“W”=警告 | “DANGER”|ERROR|ERR“|“E”|“G”=危险 |
设置列格式(价值,指数)
设置一个或多个列的列格式。 格式字符串必须符合 Microsoft Excel 标准。 看{@link https://support.office.com/en-us/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4|Create or delete a custom number format}有关创建格式化字符串的更多信息。
| 名称 | Type | Default | 描述 |
| 值 | {(string|string[])} | 要设置格式的值。 如果值是字符串,则需要 idx。 如果值是字符串数组,则可以指定或不指定匹配的索引数组。 如果指定了一个数组,则value中的每个字符串都将映射到index中相应的索引。 否则,字符串数组将取代当前的列格式 | |
| 索引 | {(integer|integer[])} | 设置格式的索引。 如果值是字符串数组,则可以指定索引数组,它将每种格式映射到相应的索引。 |
示例
| $ {DataExport1} .setColumnFormats("$#", 1) // 设置2nd列(索引 1)使用“$#”作为其格式字符串 |
| $ {DataExport1} .setColumnFormats(["$#","#,##0.00","#%"], [1,3,5]) // 设置2nd,4th, 和6th列(索引 1、3 和 5)使用“$#”、“#,## 0.00"和"#%"分别作为其格式字符串 |
| $ {DataExport1} .setColumnFormats(["$#","#,##0.00","#%"]) // 设置格式1st,2nd, 和3rd要使用的列为“$#”、“#,##” 0.00"和"#%"分别作为其格式字符串 |
设置列标题(标题)
设置列标题。
| 名称 | Type | Default | 描述 |
| 页眉 | {string[]} | 列标题列表 |
示例
| ${DataExport1}.setColumnHeaders(["ID","Name","Role","DOB" ]) // 将列标题的标签设置为“ID”、“名称”、“角色”和“DOB” |
设置ColumnNamesIncluded (旗帜)
设置列名是否应包含在输出文件中。 注意:当控件绑定到数据时,这没有效果。
| 名称 | Type | Default | 描述 |
| 标志 | {boolean} | 设置true在输出文件中包括列标题,false把它们排除在外 |
遗传设置启用(已启用,必需的)
启用/禁用此视图/控件
| 名称 | Type | Default | 描述 |
| 已启用 | {boolean} | 启用/只读标志(true要启用视图,false禁用/设为只读) | |
| required | {boolean} | 启用/禁用控件的必填字段标志 |
示例
| MyView.setEnabled(false ); //制作MyView只读 |
设置文件名(姓名)
设置输出文件应具有的默认文件名。 用户可以在保存时更改文件名。
| 名称 | Type | Default | 描述 |
| 名称 | {string} | 输出文件应具有的默认名称。 用户可以在保存时更改文件名。 |
设置文件类型(类型)
设置输出文件格式
| 名称 | Type | Default | 描述 |
| 类型 | {string} | 要输出的文件格式。 可接受的值包括“xlsx”和“csv”。 |
设置帮助文本(文本)
设置导出按钮的帮助文本
| 名称 | Type | Default | 描述 |
| 文本 | {string} | 可设置滚动文字 |
设置图标(图标)
设置导出按钮上显示的图标
| 名称 | Type | Default | 描述 |
| icon | {string} | 看{@link http://fontawesome.io/icons Font Awesome}以获取完整的图标列表。 请参阅知识中心以获取最新的 Font Awesome 版本。 |
设置InvisibleColumnsIncluded (旗帜)
设置是否应在输出文件中包含隐藏的列/字段
| 名称 | Type | Default | 描述 |
| 标志 | {boolean} | 设置true在输出文件中包括隐藏的列/字段,false把它们排除在外 |
遗传设置标签可见(可见的)
显示/隐藏此视图/控件的标签
| 名称 | Type | Default | 描述 |
| 可视 | {boolean} | 标签可见性标志(true显示视图标签,false隐藏) |
示例
| MyView.setLabelVisible(false); |
设置大纲(大纲)
设置导出按钮的轮廓样式
| 名称 | Type | Default | 描述 |
| 大纲 | {boolean} | {true | false} |
设置形状样式(风格)
设置导出按钮的形状样式。 注意:为避免歧义,请始终使用“D”|“R”|“F”设置形状样式
| 名称 | Type | Default | 描述 |
| 样式 | {string} | “默认”|“D”=默认 | “ROUNDED”|ROUND“|“R”=圆形 | “FLAT”|“F”=平面 |
设置尺寸样式(风格)
设置导出按钮的大小样式。 注意:为避免歧义,请始终使用“D”|“S”|“L”|“X”设置尺寸样式
| 名称 | Type | Default | 描述 |
| 样式 | {string} | “默认”|“DEF”|“正常”|“D”=默认 | “小”|“S”=小 | “大”|“L”=大 | “特小”|“超小”|“XS”|“X”=超小 |
设置标签索引(标签索引)
设置标签索引DataExport控制
| 名称 | Type | Default | 描述 |
| tabIndex | {integer} | 标签索引从 1 开始,可以稀疏设置 |
设置目标控制(控制)
设置用于填充电子表格的控件
| 名称 | Type | Default | 描述 |
| 控件 (control) | {(string|object)} | 要使用的控件的名称,或者要使用的控件的视图引用 |
示例
| $ {DataExport1} .setTargetControl("Table3") // 将目标控件设置为Table3 |
| $ {DataExport1} .setTargetControl(${Table3}) // 设置目标的另一种方法Table3,这次经过Table3本身 |
设置文本(文本)
设置导出按钮的文字
| 名称 | Type | Default | 描述 |
| 文本 | {string} | 导出按钮上要设置的文本 |
遗传设置ViewData (数据,createPseudoBinding)
设置/更新与此视图/控件相关的绑定数据。 仅适用于具有绑定数据的视图/控件。
笔记:只应与简单类型绑定或具有简单类型属性的复杂类型绑定一起使用。
不应与具有列表或复杂类型属性的绑定一起使用。 对于复杂类型,使用以下方式设置绑定
这
笔记:只应与简单类型绑定或具有简单类型属性的复杂类型绑定一起使用。
不应与具有列表或复杂类型属性的绑定一起使用。 对于复杂类型,使用以下方式设置绑定
这
binding.set知识中心部分详细介绍的模式绑定数据和配置选项| 名称 | Type | Default | 描述 |
| 数据 | {Object} | 绑定数据的值。 此参数的类型必须与绑定数据的类型匹配。 | |
| createPseudoBinding | {boolean} | 如果设置为 true,则在没有当前绑定的情况下创建伪绑定。 |
示例
| MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
遗传设置可见(可见的,坍塌)
显示/隐藏此视图/控件
| 名称 | Type | Default | 描述 |
| 可视 | {boolean} | 可见性标志(true显示视图,false隐藏) | |
| 折叠 | {boolean} | 设置true折叠控制空间时visible被设定为false。 |
示例
| MyView.setVisible(false, false); //相当于MyView。隐藏() |
| MyView.setVisible(false, true); // 将可见性设置为“无” |
设置宽度(宽度)
设置导出按钮的宽度(例如50px,20%, 2em - 省略单位,假设为 px)
| 名称 | Type | Default | 描述 |
| 宽度 | {string} | DataExport宽度 |
遗传展示()
显示此视图/控件
示例
| MyView。展示(); |
遗传触发公式更新( [阶段])
广播指定视图的表达式触发器
| 名称 | Type | Default | 描述 |
| 阶段 | {int} | bpmext.ui.PHASE_NORMAL | 我们目前所处的阶段 |
示例
| MyView.triggerFormulaUpdates(); |