v4 docs

Search…
v4 docs
​TableExport​
The simple, easy-to-implement library to export HTML tables to xlsx, xls, csv, and txt files.
​​
​ ​
​ ​
​ ​
​​
Deprecation notice:
Below are the docs for v4.0.11.
Check out v5 for the latest release.
Docs
​Migrating from 3.x to 4.x?​
​v3 docs and README:
​v4 docs and README:
Getting Started
Install manually using <script> tags
To use this library, include the FileSaver.js library, and TableExport library before the closing <body> tag of your HTML document:
1
<script src="FileSaver.js"></script>
2
...
3
<script src="tableexport.js"></script>
Copied!
Install with Bower
1
$ bower install tableexport.js
Copied!
Install with npm
1
$ npm install tableexport
Copied!
CDN
CDNjs
​
uncompressed
compressed
CSS
​🔗​
​🔗​
JS
​🔗​
​🔗​
Images
—
​🔗xlsx​🔗xls​🔗csv​🔗txt​
unpkg
​
uncompressed
compressed
CSS
​🔗​
​🔗​
JS
​🔗​
​🔗​
Images
—
​🔗xlsx​🔗xls​🔗csv​🔗txt​
Dependencies
Required:
​FileSaver.js​
Optional:
​jQuery (1.2.1 or higher)
​Bootstrap (3.1.0 or higher)
Add-Ons:
In order to provide Office Open XML SpreadsheetML Format ( .xlsx ) support, you must include the following third-party library in your project before both FileSaver.js and TableExport.
​xlsx.core.js by SheetJS
Including xlsx.core.js is NOT necessary if installing with Bower or npm​
1
<script src="xlsx.core.js"></script>
2
<script src="FileSaver.js"></script>
3
...
4
<script src="tableexport.js"></script>
Copied!
Older Browsers:
To support legacy browsers ( Chrome < 20, Firefox < 13, Opera < 12.10, IE < 10, Safari < 6 ) include the Blob.js polyfill before the FileSaver.js script.
​Blob.js by eligrey (forked by clarketm)
Including Blob.js is NOT necessary if installing with Bower or npm​
1
<script src="Blob.js"></script>
2
<script src="FileSaver.js"></script>
3
...
4
<script src="tableexport.js"></script>
Copied!
Usage
JavaScript
To use this library, simple call the TableExport constructor:
1
new TableExport(document.getElementsByTagName("table"));
2
​
3
// OR simply
4
​
5
TableExport(document.getElementsByTagName("table"));
6
​
7
// OR using jQuery
8
​
9
$("table").tableExport();
Copied!
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.
1
/* Defaults */
2
TableExport(document.getElementsByTagName("table"), {
3
  headers: true, // (Boolean), display table headers (th or td elements) in the <thead>, (default: true)
4
  footers: true, // (Boolean), display table footers (th or td elements) in the <tfoot>, (default: false)
5
  formats: ["xls", "csv", "txt"], // (String[]), filetype(s) for the export, (default: ['xls', 'csv', 'txt'])
6
  filename: "id", // (id, String), filename for the downloaded file, (default: 'id')
7
  bootstrap: false, // (Boolean), style buttons using bootstrap, (default: true)
8
  exportButtons: true, // (Boolean), automatically generate the built-in export buttons for each of the specified formats (default: true)
9
  position: "bottom", // (top, bottom), position of the caption element relative to table, (default: 'bottom')
10
  ignoreRows: null, // (Number, Number[]), row indices to exclude from the exported file(s) (default: null)
11
  ignoreCols: null, // (Number, Number[]), column indices to exclude from the exported file(s) (default: null)
12
  trimWhitespace: true // (Boolean), remove all leading/trailing newlines, spaces, and tabs from cell text in the exported file(s) (default: false)
13
});
Copied!
Note: to use the xlsx filetype, you must include js-xlsx; reference the Add-Ons section.
Properties
​headers​
​footers​
​formats​
​filename​
​bootstrap​
​exportButtons​
​position​
​ignoreRows​
​ignoreCols​
​trimWhitespace​
Methods
TableExport supports additional methods (getExportData, update, reset and remove) to control the TableExport instance after creation.
1
/* First, call the `TableExport` constructor and save the return instance to a variable */
2
var table = TableExport(document.getElementById("export-buttons-table"));
Copied!
getExportData
1
/* get export data */
2
var exportData = table.getExportData(); // useful for creating custom export buttons, i.e. when (exportButtons: false)
3
​
4
/*****************
5
 ** exportData ***
6
 *****************
7
{
8
    "export-buttons-table": {
9
        xls: {
10
            data: "...",
11
            fileExtension: ".xls",
12
            filename: "export-buttons-table",
13
            mimeType: "application/vnd.ms-excel"
14
        },
15
        ...
16
    }
17
};
18
*/
Copied!
update
1
/* update */
2
table.update({
3
  filename: "newFile" // pass in a new set of properties
4
});
Copied!
reset
1
/* reset */
2
table.reset(); // useful for a dynamically altered table
Copied!
remove
1
/* remove */
2
table.remove(); // removes caption and buttons
Copied!
Settings
Below are some of the popular configurable settings to customize the functionality of the library.
ignoreCSS
1
/* class selector to exclude/remove cells (<td> or <th>) or rows (<tr>) from the exported file(s). */
2
TableExport.prototype.ignoreCSS = "tableexport-ignore";
3
​
4
// OR using jQuery
5
​
6
$.fn.tableExport.ignoreCSS = "tableexport-ignore";
Copied!
emptyCSS
1
/* class selector to replace cells (<td> or <th>) with an empty string (i.e. "blank cell") in the exported file(s). */
2
TableExport.prototype.emptyCSS = "tableexport-empty";
3
​
4
// OR using jQuery
5
​
6
$.fn.tableExport.emptyCSS = "tableexport-empty";
Copied!
1
/* default charset encoding (UTF-8) */
2
TableExport.prototype.charset = "charset=utf-8";
3
​
4
/* default `filename` property if "id" attribute is unset */
5
TableExport.prototype.defaultFilename = "myDownload";
6
​
7
/* default class to style buttons when not using Bootstrap or the built-in export buttons, i.e. when (`bootstrap: false` & `exportButtons: true`)  */
8
TableExport.prototype.defaultButton = "button-default";
9
​
10
/* Bootstrap classes used to style and position the export button, i.e. when (`bootstrap: true` & `exportButtons: true`) */
11
TableExport.prototype.bootstrapConfig = ["btn", "btn-default", "btn-toolbar"];
12
​
13
/* row delimeter used in all filetypes */
14
TableExport.prototype.rowDel = "\r\n";
Copied!
1
/* Format-specific configuration (default class, content, and separator) */
2
​
3
/* Excel Open XML spreadsheet (.xlsx) */
4
TableExport.prototype.xlsx = {
5
  defaultClass: "xlsx",
6
  buttonContent: "Export to xlsx",
7
  mimeType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
8
  fileExtension: ".xlsx"
9
};
10
​
11
/* Excel Binary spreadsheet (.xls) */
12
TableExport.prototype.xls = {
13
  defaultClass: "xls",
14
  buttonContent: "Export to xls",
15
  separator: "\t",
16
  mimeType: "application/vnd.ms-excel",
17
  fileExtension: ".xls"
18
};
19
​
20
/* Comma Separated Values (.csv) */
21
TableExport.prototype.csv = {
22
  defaultClass: "csv",
23
  buttonContent: "Export to csv",
24
  separator: ",",
25
  mimeType: "application/csv",
26
  fileExtension: ".csv"
27
};
28
​
29
/* Plain Text (.txt) */
30
TableExport.prototype.txt = {
31
  defaultClass: "txt",
32
  buttonContent: "Export to txt",
33
  separator: "  ",
34
  mimeType: "text/plain",
35
  fileExtension: ".txt"
36
};
Copied!
CSS
​TableExport packages with customized Bootstrap CSS stylesheets to deliver enhanced table and button styling. These styles can be enabled by initializing with the bootstrap property set to true.
1
TableExport(document.getElementsByTagName("table"), {
2
  bootstrap: true
3
});
Copied!
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
✓
✓
✓
✓
✓
A full list of browser support can be found in the FileSaver.js README. Some legacy browsers may require an additional third-party dependency: Blob.js​
Examples
Customizing Properties
​headers​
​footers​
​formats​
​filename​
​bootstrap​
​exportButtons​
​position​
​ignoreRows​
​ignoreCols​
​trimWhitespace​
Customizing Settings
​ignoreCSS​
​emptyCSS​
Miscellaneous
​cell data types (string, number, boolean, date)
​emoji​
​Arabic​
Skeletons
​TableExport + RequireJS skeleton.
​TableExport + Flask skeleton.
​TableExport + Webpack 1 skeleton.
​TableExport + Angular 4 + Webpack 2 skeleton.
License
​TableExport is licensed under the terms of the Apache-2.0 License
Going Forward
TODOs
Update JSDocs and TypScript definition file.
Fix bug with CSV and TXT ignoreRows and ignoreCols (rows/cols rendered as empty strings rather than being removed).
Reimplement and test the update, reset, and remove TableExport prototype properties without requiring jQuery.
Make jQuery as peer dependency and ensure proper TableExport rendering in browser, AMD, and CommonJS environments.
Force jQuery to be an optionally loaded module.
Use the enhanced SheetJS xls, csv, and txt formats (exposed via enforceStrictRFC4180 prototype property).
Allow ignoreCSS and emptyCSS to work with any selector|selector[] instead of solely a single CSS class.
Ensure (via testing) full consistency and backwards-compatibility for jQuery.
Add Export as PDF support.
Credits
Special thanks the the following contributors:
​SheetJS - js-xlsx
​Eli Grey - FileSaver.js & Blob.js