Export From HTML Table Using jQuery

Export From HTML Table

[toc]

Introduction

In this article, we will see how to export from an HTML table using jQuery. We all work in some applications where we are playing with data’s. It might be some data returned by the server or it might be some client-side data like HTML table. No matter whichever forms the data is, there will be an export option. Isn’t it? 80% of our clients need the data to be exported to excel. So we need to give the option to export the given data to excel, not dependent on the data format. In my case, my data is in the form of an HTML table, so in this post, we will explain how to export an HTML data to excel, pdf, png, jpeg etc. I hope you will like it.

Download Files here: HTML Table Export

Background

As I said earlier, this article explains how to export an HTML table using jQuery. In this article we will see how we can export the given data to the following formats:

  • Excel
  • PDF
  • Image
  • CSV
  • PPT
  • Word
  • TXT
  • XML

You can always see other exporting related articles here.

Why

In my project, we are doing 80% of our work in the client side. So I decided to implement the export feature in the client side itself. The same can be done using server-side code also but I prefer the client-side one.

What you must know

Using the code

Before you start, you need to download the necessary files from TableExport.jquery.plugin.

Once you have download the files, you need to include those in your project. Here I am using a MVC4 web application.

[js]
<script src=“~/Contents/jquery-1.9.1.js”></script>
<script src=“~/Contents/tableExport.js”></script> @*Main file which does export feature *@
<script src=“~/Contents/jquery.base64.js”></script> @*Main file which does convert the content to base64 *@
<script src=“~/Contents/html2canvas.js”></script> @*Main file which does export to image feature *@
<script src=“~/Contents/jspdf/libs/base64.js”></script> @*Main file which does convert the content to base64 for pdf *@
<script src=“~/Contents/jspdf/libs/sprintf.js”></script> @*Main file which does export feature for pdf *@
<script src=“~/Contents/jspdf/jspdf.js”></script> @*Main file which does export feature for pdf *@
[/js]

Let’s say you have an HTML table as follows:

[html]
<table id=“activity” >
<thead>
<tr>
<th>Name</th>
<th>Activity on Code Project (%)</th>
<th>Activity on C# Corner (%)</th>
<th>Activity on Asp Forum (%)</th>
</tr>
</thead>
<tbody>
<tr>
<td>Sibeesh</td>
<td>100</td>
<td>98</td>
<td>80</td>
</tr>
<tr>
<td>Ajay</td>
<td>90</td>
<td>0</td>
<td>50</td>
</tr>
<tr>
<td>Ansary</td>
<td>100</td>
<td>20</td>
<td>10</td>
</tr>
<tr>
<td>Aghil</td>
<td>0</td>
<td>30</td>
<td>90</td>
</tr>
<tr>
<td>Arya</td>
<td>0</td>
<td>0</td>
<td>95</td>
</tr>
</tbody>
</table>
[/html]

Add some more UI elements for firing the click events.

[html]
<table>
<tr id=“footerExport”>
<td id=“exportexcel”><img src=“~/icons/xls.png” title=“Export to Excel” /></td>
<td id=“exportpdf”><img src=“~/icons/pdf.png” title=“Export to PDF” /></td>
<td id=“exportimage”><img src=“~/icons/png.png” title=“Export to PNG” /></td>
<td id=“exportcsv”><img src=“~/icons/csv.png” title=“Export to CSV” /></td>
<td id=“exportword”><img src=“~/icons/word.png” title=“Export to Word” /></td>
<td id=“exporttxt”><img src=“~/icons/txt.png” title=“Export to TXT” /></td>
<td id=“exportxml”><img src=“~/icons/xml.png” title=“Export to XML” /></td>
<td id=“exportppt”><img src=“~/icons/ppt.png” title=“Export to PPT” /></td>
</tr>
</table>
[/html]

Add a few styles to the table to make it viewable.

[css]
<style>
#activity {
text-align:center;border:1px solid #ccc;
}
#activity td{
text-align:center;border:1px solid #ccc;
}
#footerExport td{
cursor:pointer;
text-align:center;border:1px solid #ccc;
border:none;
}
</style>
[/css]

Now it is time to fire our events 🙂 You can do that as in the following.
[js]
<script>
$(document).ready(function () {
$(‘#exportexcel’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘excel’, escape: ‘false’ });
});
$(‘#exportpdf’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘pdf’, escape: ‘false’ });
});
$(‘#exportimage’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘png’, escape: ‘false’ });
});
$(‘#exportcsv’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘csv’, escape: ‘false’ });
});
$(‘#exportppt’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘powerpoint’, escape: ‘false’ });
});
$(‘#exportxml’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘xml’, escape: ‘false’ });
});
$(‘#exportword’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘doc’, escape: ‘false’ });
});
$(‘#exporttxt’).bind(‘click’, function (e) {
$(‘#activity’).tableExport({ type: ‘txt’, escape: ‘false’ });
});
});
</script>
[/js]

Please note that you can export to a few more formats in the same way. You can learn more here:tableExport.jquery.plugin.

Explanation

Now its time go deeper into that plugin. In the downloaded files you can see a file called tableExport.js. just open that file, you can see some conditions for specific formats. And the default property for exporting as follows.
[js]
var defaults = {
separator: ‘,’,
ignoreColumn: [],
tableName:‘yourTableName’,
type:‘csv’,
pdfFontSize:7,
pdfLeftMargin:20,
escape:‘true’,
htmlContent:‘false’,
consoleLog:‘false’
};
[/js]

You can change these properties depending on your needs as follows.

[js]
var varpdfFontSize= ‘7’;
$(‘#activity’).tableExport({ type: ‘excel’, escape: ‘false’,pdfFontSize:varpdfFontSize});
[/js]

You can try all the properties listed above like this :).

Now in that file you can see an if else if condition that is satisfied for multiple formats. Let me explain for Excel formatting alone.

[js]
var excel=“<table>”;
// Header
$(el).find(‘thead’).find(‘tr’).each(function() {
excel += “<tr>”;
$(this).filter(‘:visible’).find(‘th’).each(function(index,data) {
if ($(this).css(‘display’) != ‘none’){
if(defaults.ignoreColumn.indexOf(index) == -1){
excel += “<td>” + parseString($(this))+ “</td>”;
}
}
});
excel += ‘</tr>’;
});
// Row Vs Column
var rowCount=1;
$(el).find(‘tbody’).find(‘tr’).each(function() {
excel += “<tr>”;
var colCount=0;
$(this).filter(‘:visible’).find(‘td’).each(function(index,data) {
if ($(this).css(‘display’) != ‘none’){
if(defaults.ignoreColumn.indexOf(index) == -1){
excel += “<td>”+parseString($(this))+“</td>”;
}
}
colCount++;
});
rowCount++;
excel += ‘</tr>’;
});
excel += ‘</table>’
if(defaults.consoleLog == ‘true’){
console.log(excel);
}
var excelFile = “<html xmlns:o=’urn:schemas-microsoft-com:office:office’ xmlns:x=’urn:schemas-microsoft-com:office:”+defaults.type+“‘ xmlns=’http://www.w3.org/TR/REC-html40′>”;
excelFile += “<head>”;
excelFile += “<!–[if gte mso 9]>”;
excelFile += “<xml>”;
excelFile += “<x:ExcelWorkbook>”;
excelFile += “<x:ExcelWorksheets>”;
excelFile += “<x:ExcelWorksheet>”;
excelFile += “<x:Name>”;
excelFile += “{worksheet}”;
excelFile += “</x:Name>”;
excelFile += “<x:WorksheetOptions>”;
excelFile += “<x:DisplayGridlines/>”;
excelFile += “</x:WorksheetOptions>”;
excelFile += “</x:ExcelWorksheet>”;
excelFile += “</x:ExcelWorksheets>”;
excelFile += “</x:ExcelWorkbook>”;
excelFile += “</xml>”;
excelFile += “<![endif]–>”;
excelFile += “</head>”;
excelFile += “<body>”;
excelFile += excel;
excelFile += “</body>”;
excelFile += “</html>”;
var base64data = “base64,” + $.base64.encode(excelFile);
window.open(‘data:application/vnd.ms-‘+defaults.type+‘;filename=exportData.doc;’ + base64data);
[/js]

Procedure

  • Find the UI element (in this case it is our HTML table).
  • Loop through the rows of the thread for the header information.
  • Apply a filter to avoid the UI elements that have a display as none (filter(‘:visible’)).
  • If the UI is visible, append it to the variable (excel += “” + parseString($(this))+ “”;)
  • The same procedure is done for the row vs column values also. The only difference is, here we are looping through the tbody instead of thread.
  • After the data is manipulated, data is formulated in the Excel format.

You can learn more in the attachment.

Output

Export From HTML Table

Export From HTML Table

Points of Interest

jquery, CSS, HTML, Export

History

1st version: 18-11-2014
2nd Version: 24-11-2014

Changes did

  1. Added Images to UI elements
  2. Added some export feature

Conclusion

Did I miss anything that you may think which is needed? Could you find this post as useful? I hope you liked this article. Please share me your valuable suggestions and feedback.

Your turn. What do you think?

A blog isn’t a blog without comments, but do try to stay on topic. If you have a question unrelated to this post, you’re better off posting it on C# Corner, Code Project, Stack Overflow, Asp.Net Forum instead of commenting here. Tweet or email me a link to your question there and I’ll definitely try to help if I can.

Kindest Regards
Sibeesh Venu

72 thoughts on “Export From HTML Table Using jQuery”

  1. Pingback: Tracy Glastrong

  2. Hello, my problem is I have to show 13 columns and not as samples all, I think that can be the size of the columns and the space between them but not change either the spaces between columns or something, as I show in letter image is very small, I know how to make it bigger, but not how to make me leave the entire table since many columns and do not fit that way

  3. Hi! i am having 15 columns if i ignore column 12 and 13 its ignoring bit also ignoring column 1,2 and 3 also,so pls tell how to solve that

  4. Hi! am having 10 columns and i will export it as pdf then only 4 columns are displaying in the pdf file.i need to display all column ,plz help me….

    1. hey @disqus_qIzRZtUfXy:disqus .. In tableExport.js file locate at pdf section and change the code below row/column section
      ” var colPosition=startColPosition+(index*50); ”
      into
      “var colPosition=startColPosition+(index*10);”

      this may help for 10 columns….. or even try various numbers to be multiplied with the index value to get all the columns of a table in clear format..

        1. I have a html table. And while exporting it to pdf i get only the table headings and table data. Is there any code to print the table border in pdf.. Or we should write any code in tableExport.js to print the table border? if so suggest me some ideas.
          thanks

          1. Hey hi, in the tableExport.js there is a loop which actually looping though the th’s and td’s available. There you can get the CSS and apply when we create dynamic td’s and th’s. Please check that file. Hope this helps. It would be great if you can share the code or steps here once after you did the requirement. Thank you.

  5. Hey sabeesh , Abinesh here….. i’ve tried with similar one myselft…. while using window.open command to open excel file…. Excel is prompting with error … Is there any method to solve this error… Thanks in advance!!!

      1. Here’s the prompt in EXCEL… it can render the HTML but shownig the prompt ….. I just wanted this warning to not to be displayed.

  6. HI ,
    I am getting following error:
    Uncaught TypeError: $(…).tableExport is not a function(anonymous function) x.event.dispatch
    jquery.min.js:5y.handle
    jquery.min.js:5

    Can you please help!!

    1. Hi, can you please check whether all the needed references are loaded correctly?and also please make sure that you load JQuery and JQuery ui on top of any other files. Thanks

  7. Hi sibeesh ,

    sakshi here actually to be frank m not that good with JQuery can u tell me that how to integrate your code exacly in my code as my data comes from xampp database need to export that selected data to excel format , i have already included file named tableExport.js and tried to call it using <input type="submit" value="Generate Report" but it is not even calling the function and not even giving any error so can u plz help me out on this its urgent so plz respond ASAP i have to submit within 2 weeks plz try to respond ASAP.

    1. Hi, can you please try to implement a try catch while calling the function and check you get any error in browser console?Please check whether all the needed references are loaded correctly?And also please make sure that you load JQuery and JQuery ui on top of any other files. Thanks

    1. here this is my code to export in excel

      var tableToExcel = (function () {

      var uri = ‘data:application/vnd.ms-excel;base64,’

      , template = ‘Attendance{table}’

      , base64 = function (s) { return window.btoa(unescape(encodeURIComponent(s))) }

      , format = function (s, c) { return s.replace(/{(w+)}/g, function (m, p) { return c[p]; }) }

      return function (table, name) {

      if (!table.nodeType) table = document.getElementById(table)

      var ctx = { worksheet: ‘Attendance’ || ‘Worksheet’, table: table.innerHTML }

      var date1 = $(“#ctl00_ContentPlaceHolder1_txtFromDate”).val();

      var date2 = $(“#ctl00_ContentPlaceHolder1_txtToDate”).val();

      ////window.location.href = uri + base64(format(template, ctx))

      var link = document.createElement(“a”);

      link.download = date1 + “_To_” + date2 + “.xls”;

      link.href = uri + base64(format(template, ctx));

      link.click();

      }

      })()

  8. can we have an option that when click to export pdf button then allow user to save anywhere he/she wants to save the file. Means save as option.

  9. Hi Sibeesh, I have done exporting my table as excel. Everything works well but the colspan and rowspan given to the cells are not with the excel generated. Is there any option to display colspan and rowspan?

      1. Tanks for the reply. I solved my problem, here is my code
        $(this).filter(‘:visible’).find(‘th’).each(function(index,data) {
        if ($(this).css(‘display’) != ‘none’){
        if(defaults.ignoreColumn.indexOf(index) == -1){
        colSpan = ($(this).prop(“colSpan”) > 0) ? $(this).prop(“colSpan”) : 1;
        rowSpan = ($(this).prop(“rowSpan”) > 0) ? $(this).prop(“rowSpan”) : 1;
        excel += “” + parseString($(this))+ “”;
        }
        }
        });

        1. Sorry for my late reply. I suggest you to debug in the file tableExport.js. In that file you can find the if condition for pdf, please put a break point and check why those columns are not adding.

          1. Hello Sibeesh, as per my testing, from the tableExport.js each columns are added into the table, but there is something wrong with jspdf.js. it will not populate the large width table into A4 size portrait of pdf and i am not able to understand the code of it.

                  1. I had created a fiddle for you..
                    http://jsfiddle.net/nzp5o8cm/1/

                    if you download table as excel it works perfect.
                    if you export as pdf then file doesn’t show up in new tab. if you save that new tab then it saves the data as pdf file.. and that is not proper as i described earlier.

                    1. I tried debugging. The data and all is taking. Even the loop count is correct. It seems there is some issue while passing datauri. Will check and let you know. Thank you

                    2. Hi Sibeesh, I also had checked everything that you said and that everything is correct. but still it’s not populating the pdf ‘A4’ size file. so might be the issue in jsPdf.js
                      please provide the resolution asap..

  10. Hi Sibeesh,
    Its not woking on the dynamic data which is getting populated in the table. Its only exporting the static headers. Please help.

    1. Yes, I think, since you use normal html control like span and all. It will just export the table with the style you have given. It would be great if you could try and share the result. Thanks in advance.

    1. Yes sure. In tableExport.js file. Please remove the visible condition. It will take hidden td’s also then.

      .filter(‘:visible’) remove this from each statement. I hope it helps.

  11. Hi, This is not working in IE9. I’m getting this error: Object doesn’t support property or method ‘btoa’. Do you have any workaround?

Leave a Reply

Your email address will not be published. Required fields are marked *

Serverless 360