按钮.exportInfo()

自：按钮 1.4.0

获取与多种不同按钮类型通用的导出元信息。
请注意 - 此属性需要按钮DataTables 扩展。

描述

按钮最常用的功能是其显示按钮以导出表格中数据的功能 - 复制到剪贴板、打印或本地创建的数据文件。提供此功能的每种按钮类型都有其自己的选项范围（例如，CSV 按钮类型可以修改字段分隔字符，使其成为 TSV 导出），除了每个选项之外还有公共选项。此方法提供这些常用选项，确保 API 中的一致性以及代码的重复使用。

通常，您不太可能在导出按钮之外使用此方法，但它可以供自定义按钮公开使用。

类型

function 按钮.exportInfo( [ 选项 ] )

描述

参数

名称类型可选

	名称	类型	可选
1	`选项`	`对象`	是
	此选项通常为按钮配置对象 - 即用于定义按钮行为的对象，允许各种按钮类型使用一组通用的选项，这些选项提供相同的功能以保持一致性。使用此对象中的属性： `扩展` - 如果按钮创建外部文件，应附加到 `文件名` 选项的文件名扩展名。 `字符串` - 应使用的静态字符串 `函数` - 解析函数并使用返回值 `文件名` - 如果创建外部文件，则为文件指定名称。 `` (默认) - 使用 HTML 页面的 `title` 元素的值 `字符串` - 应使用的静态字符串 `函数` - 解析函数并使用返回值 `messageBottom` - 显示在导出的表格下方 `` (默认) - 如果有，且且设置为 `caption-side: bottom`，则使用表格的 `caption` 标记的值。 `null` - 在输出中不显示底部消息 `字符串` - 应使用的静态字符串 `函数` - 解析函数并使用返回值 `messageTop` - 显示在导出文档中标题和表格之间 `` (默认) - 如果有，且且设置为 `caption-side: top`，则使用表格的 `caption` 标记的值。 `null` - 在输出中不显示顶部消息 `字符串` - 应使用的静态字符串 `函数` - 解析函数并使用返回值 `title` - 显示在导出文档的最顶部 `` (默认) - 使用 HTML 页面的 `title` 值. `null` - 在输出中不显示标题。 `字符串` - 应使用的静态字符串 `函数` - 解析函数并使用返回值请注意，对于每次选项，当作为函数给出时，返回值应为字符串。另外，传递给函数以下参数按钮的配置对象（自按钮 3.0 起）当前表格的 DataTables API 实例（自按钮 3.0 起）。

选项

对象

是

此选项通常为按钮配置对象 - 即用于定义按钮行为的对象，允许各种按钮类型使用一组通用的选项，这些选项提供相同的功能以保持一致性。

使用此对象中的属性：

扩展 - 如果按钮创建外部文件，应附加到 文件名 选项的文件名扩展名。
- 字符串 - 应使用的静态字符串
- 函数 - 解析函数并使用返回值
文件名 - 如果创建外部文件，则为文件指定名称。
- * (默认) - 使用 HTML 页面的 title 元素的值
- 字符串 - 应使用的静态字符串
- 函数 - 解析函数并使用返回值
messageBottom - 显示在导出的表格下方
- * (默认) - 如果有，且且设置为 caption-side: bottom，则使用表格的 caption 标记的值。
- null - 在输出中不显示底部消息
- 字符串 - 应使用的静态字符串
- 函数 - 解析函数并使用返回值
messageTop - 显示在导出文档中标题和表格之间
- * (默认) - 如果有，且且设置为 caption-side: top，则使用表格的 caption 标记的值。
- null - 在输出中不显示顶部消息
- 字符串 - 应使用的静态字符串
- 函数 - 解析函数并使用返回值
title - 显示在导出文档的最顶部
- * (默认) - 使用 HTML 页面的 title 值.
- null - 在输出中不显示标题。
- 字符串 - 应使用的静态字符串
- 函数 - 解析函数并使用返回值

请注意，对于每次选项，当作为函数给出时，返回值应为字符串。另外，传递给函数以下参数

按钮的配置对象（自按钮 3.0 起）
当前表格的 DataTables API 实例（自按钮 3.0 起）。

返回值

对象

一个具有以下参数的对象

filename - 应为按钮所创建的任何文件使用文件名
messageTop - 导出的数据内容顶部显示的消息（title 之后）
messageBottom - 导出的数据内容底部显示的消息
title - 导出数据中显示的标题。

示例

在自定义按钮中获取导出信息

var table = new DataTable('#myTable', {
	buttons: [
		{
			text: 'My button',
			action: function (e, dt, button, config) {
				var info = dt.buttons.exportInfo();
				// Do something with the 'info' variable when creating custom export
			}
		}
	]
});