有的時候,前台已經用 HTML 動態渲染好了報表,還配備了一個 date range 組件——拖動它,報表便能在不提交後台的情況下即時刷新。這時候如果用戶想導出 PDF,就需要在純前端完成「HTML 轉 PDF」的工作,jsPDF 正是為此而生的利器。
需要用到的組件有:
jquery.js jspdf.js canvg.js html2canvas.js jspdf.plugin.autotable.js
前台動態生成的圖表通常用 HTML5 的 canvas 或 svg 繪製,而本文遇到的正是 svg。由於報表還需要保持原頁面的外觀,真正要轉成 PDF 的其實是「HTML + svg」的組合。
這裡有兩個前提需要明確:其一,jsPDF 雖然支持 HTML,但支持得並不理想,直接用一段 HTML 生成 PDF 時,往往只保留了文本,樣式與結構全都丟失(比如 table 就沒了);其二,jsPDF 並不支持直接導入 svg。
因此整體思路是:先把 svg 轉成 canvas,再把 HTML + canvas 合成 canvas,然後用 html2canvas 把 canvas 轉為圖片,最後將圖片寫入 PDF;而 table 部分則交由 jspdf.plugin.autotable.js 處理。
值得一提的是,不同浏覽器表現也有差異:Firefox 下 html2canvas 無法直接將 svg + html 轉成 canvas,需要先把 svg 元素轉成 canvas 再合成;而 Chrome 則可以直接完成。
第一步,把指定節點下的所有 svg 轉換成 canvas(依賴 canvg.js):
//將指定節點下面的所有svg轉換成canvas //這裡需要:canvg.js function svg2canvas (targetElem) { var nodesToRecover = []; var nodesToRemove = []; var svgElem = targetElem.find('svg'); svgElem.each(function(index, node) { var parentNode = node.parentNode; var svg = node.outerHTML; var canvas = document.createElement('canvas'); canvg(canvas, svg); nodesToRecover.push({ parent: parentNode, child: node }); parentNode.removeChild(node); nodesToRemove.push({ parent: parentNode, child: canvas }); parentNode.appendChild(canvas); }); } 第二步,把 HTML 內容放到一個 iframe 裡打開,以排除其他元素的干擾(實踐中發現,直接在當前頁面往往導出不成功,改用 iframe 後才奏效),並把報表用到的 CSS 重新寫入 iframe:
//這裡是將html(文本)在一個iframe裡面打開 //主要是排除其它元素的干擾導致不成功,之前是一直輸出不成功,所示才使用iframe //這段代碼是官網摳下來的。 //還有個問題就是:如果將頁面的chart轉換成canvas了,那web頁面報表動態變化的功能將丟失。 function openWithIframe(html){ var iframe = document.createElement('iframe'); iframe.setAttribute("id", "myFrmame"); var $iframe = $(iframe); $iframe.css({ 'visibility': 'hidden', 'position':'static', 'z-index':'4' }).width($(window).width()).height($(window).height()); $('body').append(iframe); var ifDoc = iframe.contentWindow.document; //這裡做是將報表使用到的css重新寫入到iframe中,根據自身的需要 var style = "<link href='/javax.faces.resource/css/auth.css.jsf' rel='stylesheet' type='text/css'>"; style+="<link href='/javax.faces.resource/css/common.css.jsf' rel='stylesheet' type='text/css'>"; style+="<link href='/javax.faces.resource/css/dc.css.jsf' rel='stylesheet' type='text/css'>"; html = "<!DOCTYPE html><html><head>"+style+"</head><body>"+html+"</body></html>" ifDoc.open(); ifDoc.write(html); ifDoc.close(); /* //這裡做一些微調,根據自身的需要 var fbody = $iframe.contents().find("body"); fbody.find("#chart-center").removeAttr("width"); fbody.find(".page-container").css("width", "370px"); fbody.find(".center-container").css("width", "600px"); fbody.find("#severity-chart svg").attr("width", "370"); fbody.find("#status-chart svg").attr("width", "300"); */ return fbody; } 第三步,封裝導出 PDF 的方法,把各個環節串聯起來:
//導出pdf function exportAsPDF(){ //得到要導出pdf的html根節點 var chartCenter = document.getElementById("chart-center").outerHTML; var fbody = openWithIframe(chartCenter); svg2canvas(fbody); //html2canvas官網的標准方法 html2canvas(fbody, { onrendered: function(canvas) { //var myImage = canvas.toDataURL("image/png"); //alert(myImage); //window.open(myImage); /* canvas.toBlob(function(blob) { saveAs(blob, "report.png"); }, "image/png"); */ //將圖片轉換成:base64編碼的jpg圖片。 var imgData = canvas.toDataURL('image/jpeg'); //alert(imgData); //l:橫向, p:縱向 var doc = new jsPDF('l', 'pt', 'a3'); //var doc = new jsPDF('p', 'mm', [290, 210]); //var doc = new jsPDF();//默認是A4,由於我的報表比較大,所以專門設置了尺寸。 doc.setFontSize(22); doc.setFontType("bolditalic"); doc.text(500, 30, "Ticket Report"); //x:500, y:30 doc.addImage(imgData, 'jpeg', 10, 60); //寫入位置:x:10, y:60 doc.addPage(); //新建一頁 //這裡就是把將table寫入到pdf裡面。 var res = doc.autoTableHtmlToJson(document.getElementById("tickets-summary-table"), true); doc.autoTable(res.columns, res.data); doc.save('ticket.report_'+new Date().getTime()+'.pdf'); $('#myFrmame').remove(); //最後將iframe刪除 }, background:"#fff", //這裡給生成的圖片默認背景,不然的話,如果你的html根節點沒有設置背景的話,會用黑色填充。 allowTaint: true //避免一些不識別的圖片干擾,默認為false,遇到不識別的圖片干擾則會停止處理html2canvas }); }; 這樣一來,一份外觀還原、圖表清晰、表格完整的 PDF 報表就能在純前端被輕鬆導出了。