pdfFlash

Since: Buttons 1.0.0

Create and save a PDF file that contains the data from the table (Adobe Flash - deprecated). Please note - this property requires the Buttons extension for DataTables.

Deprecated

As of v1.2.0 this feature has been deprecated.This feature has not yet been scheduled for removal, but its use is discouraged and the alternatives discussed below should be used.

As Flash is now being expunged from all browsers, the Flash buttons are only suitable for use in old browsers. As such, they will no longer see new features developed for them after Buttons 1.2.0. They will be removed from the distribution in the next major release.

Description

This button will create and save a PDF file from the table's data.

Please note that this button has a number of restrictions:

  • It does not support UTF8. For UTF-8 support please using the pdfHtml5 button.
  • Adobe Flash must be installed.
  • The action for this button cannot be activated using the button().trigger() method due to the security restrictions of Flash
  • The created file save dialogue must be shown and the file cannot be automatically opened.
  • Adding images etc to the PDF is possible through the AlivePDF API which this button uses to create the PDF, but it is difficult and the Flash SWF must be recompiled.

The pdfHtml5 method provides much greater flexibility and thus button is considered to be sunsetted, but is still provided for use with older browsers that do not support the APIs required for the pdfHtml5 button type.

Adobe Flash is required for this button to operate. If Flash is not installed, or disabled, in the end user's browser this button will not appear. For a non-Flash alternative please see the excelHtml5 button type. Additionally the excel will automatically select between this button and excelHtml5 depending on the features of the browser.

Options

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

Examples

DataTables initialisation: Use the Flash PDF button:

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

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

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

DataTables initialisation: Use the exportOptions to save only the data shown on the current DataTable page:

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