buttons.exportInfo()

Since: Buttons 1.4.0

Get export meta information that is common to many different button types.
Please note - this property requires the Buttons extension for DataTables.

Description

The most commonly used feature of Buttons is its ability to display buttons that export the data from the table - copy to clipboard, print or locally created data file. Each of the button types that provide this functionality has its own range of options (for example the CSV button type can have the field separator character modified to be a TSV export) in addition to options which are common to each of them. This method provides those common options, ensuring consistency in the API as well as code reuse.

Generally it is unlikely you would want to use this method outside of an export button, but it is publicly available for customised buttons.

Type

function buttons.exportInfo( [ options ] )

Description:

Parameters:

Name Type Optional

	Name	Type	Optional
1	`options`	`object`	Yes
	This option is typically a button configuration object - i.e. the object that is used to define the button's behaviour allowing the various button types to use a common set of options that provide the same abilities for consistency. The properties that are used from this object are: `extension` - File name extension that should be appended to the `filename` option if an external file is created by the button. `string` - Static string that should be used `function` - Resolve the function and use the returned value `filename` - Name to give the file if an external file is created. `` (default) - Use the HTML page's `title` element's value `string` - Static string that should be used `function` - Resolve the function and use the returned value `messageBottom` - Shown below the exported table `` (default) - Use the value of the table's `caption` tag if there is one and it is set to be `caption-side: bottom`. `null` - Do not show the bottom message in the output `string` - Static string that should be used `function` - Resolve the function and use the returned value `messageTop` - Shown between the title and the table in the exported document `` (default) - Use the value of the table's `caption` tag if there is one and* it is set to be `caption-side: top`. `null` - Do not show the top message in the output `string` - Static string that should be used `function` - Resolve the function and use the returned value `title` - Shown at the very top of the exported document `*` (default) - Use the HTML page's `title` value. `null` - Do not show a title in the output `string` - Static string that should be used `function` - Resolve the function and use the returned value Please note that for each option, when given as a function, the return value should be a string. Additionally, the function passed the following parameters: The configuration object for the Button (since Buttons 3.0) A DataTables API instance for the table in question (since Buttons 3.0).

options

object

Yes

This option is typically a button configuration object - i.e. the object that is used to define the button's behaviour allowing the various button types to use a common set of options that provide the same abilities for consistency.

The properties that are used from this object are:

extension - File name extension that should be appended to the filename option if an external file is created by the button.
- string - Static string that should be used
- function - Resolve the function and use the returned value
filename - Name to give the file if an external file is created.
- * (default) - Use the HTML page's title element's value
- string - Static string that should be used
- function - Resolve the function and use the returned value
messageBottom - Shown below the exported table
- * (default) - Use the value of the table's caption tag if there is one and it is set to be caption-side: bottom.
- null - Do not show the bottom message in the output
- string - Static string that should be used
- function - Resolve the function and use the returned value
messageTop - Shown between the title and the table in the exported document
- * (default) - Use the value of the table's caption tag if there is one and it is set to be caption-side: top.
- null - Do not show the top message in the output
- string - Static string that should be used
- function - Resolve the function and use the returned value
title - Shown at the very top of the exported document
- * (default) - Use the HTML page's title value.
- null - Do not show a title in the output
- string - Static string that should be used
- function - Resolve the function and use the returned value

Please note that for each option, when given as a function, the return value should be a string. Additionally, the function passed the following parameters:

The configuration object for the Button (since Buttons 3.0)
A DataTables API instance for the table in question (since Buttons 3.0).

Returns:

object

An object which has the following parameters:

filename - File name that should be used for any file that is created by the button
messageTop - Message to be shown at the top of the exported data's content (after the title)
messageBottom - Message to be shown at the end of the exported data's content
title - Title to show in the exported data.

Example

Get export information in a custom button:

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
			}
		}
	]
});