new TableExport(document.getElementsByTagName("table"));
// OR simply
TableExport(document.getElementsByTagName("table"));
// OR using jQuery
$("table").tableExport();
Additional properties can be passed-in to customize the look and feel of your tables, buttons, and exported data.
Notice that by default, TableExport will create export buttons for three different filetypes xls, csv, txt. You can choose which buttons to generate by setting the formats property to the filetype(s) of your choice.
/* Defaults */
TableExport(document.getElementsByTagName("table"), {
headers: true, // (Boolean), display table headers (th or td elements) in the <thead>, (default: true)
footers: true, // (Boolean), display table footers (th or td elements) in the <tfoot>, (default: false)
formats: ["xls", "csv", "txt"], // (String[]), filetype(s) for the export, (default: ['xls', 'csv', 'txt'])
filename: "id", // (id, String), filename for the downloaded file, (default: 'id')
bootstrap: false, // (Boolean), style buttons using bootstrap, (default: true)
exportButtons: true, // (Boolean), automatically generate the built-in export buttons for each of the specified formats (default: true)
position: "bottom", // (top, bottom), position of the caption element relative to table, (default: 'bottom')
ignoreRows: null, // (Number, Number[]), row indices to exclude from the exported file(s) (default: null)
ignoreCols: null, // (Number, Number[]), column indices to exclude from the exported file(s) (default: null)
trimWhitespace: true // (Boolean), remove all leading/trailing newlines, spaces, and tabs from cell text in the exported file(s) (default: false)
});
Properties
Methods
/* First, call the `TableExport` constructor and save the return instance to a variable */
var table = TableExport(document.getElementById("export-buttons-table"));
getExportData
/* get export data */
var exportData = table.getExportData(); // useful for creating custom export buttons, i.e. when (exportButtons: false)
/*****************
** exportData ***
*****************
{
"export-buttons-table": {
xls: {
data: "...",
fileExtension: ".xls",
filename: "export-buttons-table",
mimeType: "application/vnd.ms-excel"
},
...
}
};
*/
update
/* update */
table.update({
filename: "newFile" // pass in a new set of properties
});
reset
/* reset */
table.reset(); // useful for a dynamically altered table
remove
/* remove */
table.remove(); // removes caption and buttons
Settings
Below are some of the popular configurable settings to customize the functionality of the library.
ignoreCSS
/* class selector to exclude/remove cells (<td> or <th>) or rows (<tr>) from the exported file(s). */
TableExport.prototype.ignoreCSS = "tableexport-ignore";
// OR using jQuery
$.fn.tableExport.ignoreCSS = "tableexport-ignore";
emptyCSS
/* class selector to replace cells (<td> or <th>) with an empty string (i.e. "blank cell") in the exported file(s). */
TableExport.prototype.emptyCSS = "tableexport-empty";
// OR using jQuery
$.fn.tableExport.emptyCSS = "tableexport-empty";
/* default charset encoding (UTF-8) */
TableExport.prototype.charset = "charset=utf-8";
/* default `filename` property if "id" attribute is unset */
TableExport.prototype.defaultFilename = "myDownload";
/* default class to style buttons when not using Bootstrap or the built-in export buttons, i.e. when (`bootstrap: false` & `exportButtons: true`) */
TableExport.prototype.defaultButton = "button-default";
/* Bootstrap classes used to style and position the export button, i.e. when (`bootstrap: true` & `exportButtons: true`) */
TableExport.prototype.bootstrapConfig = ["btn", "btn-default", "btn-toolbar"];
/* row delimeter used in all filetypes */
TableExport.prototype.rowDel = "\r\n";
When used alongside Bootstrap, there are four custom classes .xlsx, .xls, .csv, .txt providing button styling for each of the exportable filetypes.
Browser Support
Chrome
Firefox
IE
Opera
Safari
Android
✓
✓
-
✓
-
iOS
✓
-
-
-
✓
Mac OSX
✓
✓
-
✓
✓
Windows
✓
✓
✓
✓
✓
Examples
Customizing Properties
Customizing Settings
Miscellaneous
Skeletons
License
Going Forward
TODOs
Credits
Special thanks the the following contributors:
(1.2.1 or higher)
(3.1.0 or higher)
In order to provide Office Open XML SpreadsheetML Format ( .xlsx ) support, you must include the following third-party library in your project before both and .
by SheetJS
Including xlsx.core.js is NOT necessary if installing with or
To support legacy browsers ( Chrome < 20, Firefox < 13, Opera < 12.10, IE < 10, Safari < 6 ) include the polyfill before the script.
by eligrey (forked by clarketm)
Including Blob.js is NOT necessary if installing with or
To use this library, simple call the constructor:
Note: to use the xlsx filetype, you must include ; reference the section.
TableExport supports additional methods (getExportData, update, reset and remove) to control the instance after creation.
packages with customized CSS stylesheets to deliver enhanced table and button styling. These styles can be enabled by initializing with the bootstrap property set to true.
A full list of can be found in the README. Some may require an additional third-party dependency:
(string, number, boolean, date)
skeleton.
skeleton.
skeleton.
skeleton.
is licensed under the terms of the License
Use the enhanced xls, csv, and txt formats (exposed via enforceStrictRFC4180 prototype property).
