{hero}

copy

Since: Buttons 1.0.0

Copy table data to clipboard button.
Please note - this property requires the Buttons extension for DataTables.

Description

This button type serves as a proxy that will automatically detect if the copyHtml5 or copyFlash buttons can be used based on the browser's capabilities and the libraries available on the page.

This is provided as there is no API in HTML5 that allows a copy to clipboard action when clicking a button. Flash however does provide that option, giving a potentially more desirable interface to the end user.

The order of selection, in priority order is:

If the requirements of both buttons are not satisfied, no button will be presented to the end user. For the requirements of each button type, please refer to its own documentation.

The options available to the HTML5 and Flash buttons are common between them to ensure that no additional logic is required by the developer based on which button type is selected - e.g. if you set the exportOptions option, it will be used by the HTML5 and Flash button types.

Options

This button can have the following options set in its configuration object to customise its actions and display:

Examples

DataTables initialisation: Use the copy button type to automatically select between the Flash and HTML button options.:

$('#myTable').DataTable( {
	buttons: [
		'copy'
	]
} );

DataTables initialisation: Use the exportOptions to copy only the current DataTable page:

$('#myTable').DataTable( {
	buttons: [
		{
			extend: 'copy',
			text: 'Copy current page',
			exportOptions: {
				modifier: {
					page: 'current'
				}
			}
		}
	]
} );