123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361 |
- <template>
- <div :id="idName" @click="generate">
- <slot> Download {{ name }} </slot>
- </div>
- </template>
- <script>
- import download from "./download";
- export default {
- name: "downloadExcel",
- props: {
- // mime type [xls, csv]
- type: {
- type: String,
- default: "xls",
- },
- // Json to download
- data: {
- type: Array,
- required: false,
- default: null,
- },
- // fields inside the Json Object that you want to export
- // if no given, all the properties in the Json are exported
- fields: {
- type: Object,
- default: () => null,
- },
- // this prop is used to fix the problem with other components that use the
- // variable fields, like vee-validate. exportFields works exactly like fields
- exportFields: {
- type: Object,
- default: () => null,
- },
- // Use as fallback when the row has no field values
- defaultValue: {
- type: String,
- required: false,
- default: "",
- },
- // Title(s) for the data, could be a string or an array of strings (multiple titles)
- header: {
- default: null,
- },
- // Footer(s) for the data, could be a string or an array of strings (multiple footers)
- footer: {
- default: null,
- },
- // filename to export
- name: {
- type: String,
- default: "data.xls",
- },
- fetch: {
- type: Function,
- },
- meta: {
- type: Array,
- default: () => [],
- },
- worksheet: {
- type: String,
- default: "Sheet1",
- },
- //event before generate was called
- beforeGenerate: {
- type: Function,
- },
- //event before download pops up
- beforeFinish: {
- type: Function,
- },
- // Determine if CSV Data should be escaped
- escapeCsv: {
- type: Boolean,
- default: true,
- },
- // long number stringify
- stringifyLongNum: {
- type: Boolean,
- default: false,
- },
- },
- computed: {
- // unique identifier
- idName() {
- var now = new Date().getTime();
- return "export_" + now;
- },
- downloadFields() {
- if (this.fields) return this.fields;
- if (this.exportFields) return this.exportFields;
- },
- },
- methods: {
- async generate() {
- if (typeof this.beforeGenerate === "function") {
- await this.beforeGenerate();
- }
- let data = this.data;
- if (typeof this.fetch === "function" || !data) data = await this.fetch();
- if (!data || !data.length) {
- return;
- }
- let json = this.getProcessedJson(data, this.downloadFields);
- if (this.type === "html") {
- // this is mainly for testing
- return this.export(
- this.jsonToXLS(json),
- this.name.replace(".xls", ".html"),
- "text/html"
- );
- } else if (this.type === "csv") {
- return this.export(
- this.jsonToCSV(json),
- this.name.replace(".xls", ".csv"),
- "application/csv"
- );
- }
- return this.export(
- this.jsonToXLS(json),
- this.name,
- "application/vnd.ms-excel"
- );
- },
- /*
- Use downloadjs to generate the download link
- */
- export: async function (data, filename, mime) {
- let blob = this.base64ToBlob(data, mime);
- if (typeof this.beforeFinish === "function") await this.beforeFinish();
- download(blob, filename, mime);
- },
- /*
- jsonToXLS
- ---------------
- Transform json data into an xml document with MS Excel format, sadly
- it shows a prompt when it opens, that is a default behavior for
- Microsoft office and cannot be avoided. It's recommended to use CSV format instead.
- */
- jsonToXLS(data) {
- let xlsTemp =
- '<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns="http://www.w3.org/TR/REC-html40"><head><meta name=ProgId content=Excel.Sheet> <meta name=Generator content="Microsoft Excel 11"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><!--[if gte mso 9]><xml><x:ExcelWorkbook><x:ExcelWorksheets><x:ExcelWorksheet><x:Name>${worksheet}</x:Name><x:WorksheetOptions><x:DisplayGridlines/></x:WorksheetOptions></x:ExcelWorksheet></x:ExcelWorksheets></x:ExcelWorkbook></xml><![endif]--><style>br {mso-data-placement: same-cell;}</style></head><body><table>${table}</table></body></html>';
- let xlsData = "<thead>";
- const colspan = Object.keys(data[0]).length;
- let _self = this;
- //Header
- const header = this.header || this.$attrs.title;
- if (header) {
- xlsData += this.parseExtraData(
- header,
- '<tr><th colspan="' + colspan + '">${data}</th></tr>'
- );
- }
- //Fields
- xlsData += "<tr>";
- for (let key in data[0]) {
- xlsData += "<th>" + key + "</th>";
- }
- xlsData += "</tr>";
- xlsData += "</thead>";
- //Data
- xlsData += "<tbody>";
- data.map(function (item, index) {
- xlsData += "<tr>";
- for (let key in item) {
- xlsData +=
- "<td>" +
- _self.preprocessLongNum(
- _self.valueReformattedForMultilines(item[key])
- ) +
- "</td>";
- }
- xlsData += "</tr>";
- });
- xlsData += "</tbody>";
- //Footer
- if (this.footer != null) {
- xlsData += "<tfoot>";
- xlsData += this.parseExtraData(
- this.footer,
- '<tr><td colspan="' + colspan + '">${data}</td></tr>'
- );
- xlsData += "</tfoot>";
- }
- return xlsTemp
- .replace("${table}", xlsData)
- .replace("${worksheet}", this.worksheet);
- },
- /*
- jsonToCSV
- ---------------
- Transform json data into an CSV file.
- */
- jsonToCSV(data) {
- let _self = this;
- var csvData = [];
- //Header
- const header = this.header || this.$attrs.title;
- if (header) {
- csvData.push(this.parseExtraData(header, "${data}\r\n"));
- }
- //Fields
- for (let key in data[0]) {
- csvData.push(key);
- csvData.push(",");
- }
- csvData.pop();
- csvData.push("\r\n");
- //Data
- data.map(function (item) {
- for (let key in item) {
- let escapedCSV = item[key] + "";
- // Escaped CSV data to string to avoid problems with numbers or other types of values
- // this is controlled by the prop escapeCsv
- if (_self.escapeCsv) {
- escapedCSV = '="' + escapedCSV + '"'; // cast Numbers to string
- if (escapedCSV.match(/[,"\n]/)) {
- escapedCSV = '"' + escapedCSV.replace(/\"/g, '""') + '"';
- }
- }
- csvData.push(escapedCSV);
- csvData.push(",");
- }
- csvData.pop();
- csvData.push("\r\n");
- });
- //Footer
- if (this.footer != null) {
- csvData.push(this.parseExtraData(this.footer, "${data}\r\n"));
- }
- return csvData.join("");
- },
- /*
- getProcessedJson
- ---------------
- Get only the data to export, if no fields are set return all the data
- */
- getProcessedJson(data, header) {
- let keys = this.getKeys(data, header);
- let newData = [];
- let _self = this;
- data.map(function (item, index) {
- let newItem = {};
- for (let label in keys) {
- let property = keys[label];
- newItem[label] = _self.getValue(property, item);
- }
- newData.push(newItem);
- });
- return newData;
- },
- getKeys(data, header) {
- if (header) {
- return header;
- }
- let keys = {};
- for (let key in data[0]) {
- keys[key] = key;
- }
- return keys;
- },
- /*
- parseExtraData
- ---------------
- Parse title and footer attribute to the csv format
- */
- parseExtraData(extraData, format) {
- let parseData = "";
- if (Array.isArray(extraData)) {
- for (var i = 0; i < extraData.length; i++) {
- if (extraData[i])
- parseData += format.replace("${data}", extraData[i]);
- }
- } else {
- parseData += format.replace("${data}", extraData);
- }
- return parseData;
- },
- getValue(key, item) {
- const field = typeof key !== "object" ? key : key.field;
- let indexes = typeof field !== "string" ? [] : field.split(".");
- let value = this.defaultValue;
- if (!field) value = item;
- else if (indexes.length > 1)
- value = this.getValueFromNestedItem(item, indexes);
- else value = this.parseValue(item[field]);
- if (key.hasOwnProperty("callback"))
- value = this.getValueFromCallback(value, key.callback);
- return value;
- },
- /*
- convert values with newline \n characters into <br/>
- */
- valueReformattedForMultilines(value) {
- if (typeof value == "string") return value.replace(/\n/gi, "<br/>");
- else return value;
- },
- preprocessLongNum(value) {
- if (this.stringifyLongNum) {
- if (String(value).startsWith("0x")) {
- return value;
- }
- if (!isNaN(value) && value != "") {
- if (value > 99999999999 || value < 0.0000000000001) {
- return '="' + value + '"';
- }
- }
- }
- return value;
- },
- getValueFromNestedItem(item, indexes) {
- let nestedItem = item;
- for (let index of indexes) {
- if (nestedItem) nestedItem = nestedItem[index];
- }
- return this.parseValue(nestedItem);
- },
- getValueFromCallback(item, callback) {
- if (typeof callback !== "function") return this.defaultValue;
- const value = callback(item);
- return this.parseValue(value);
- },
- parseValue(value) {
- return value || value === 0 || typeof value === "boolean"
- ? value
- : this.defaultValue;
- },
- base64ToBlob(data, mime) {
- let base64 = window.btoa(window.unescape(encodeURIComponent(data)));
- let bstr = atob(base64);
- let n = bstr.length;
- let u8arr = new Uint8ClampedArray(n);
- while (n--) {
- u8arr[n] = bstr.charCodeAt(n);
- }
- return new Blob([u8arr], { type: mime });
- },
- }, // end methods
- };
- </script>
|