"use strict"; require("core-js/modules/es.symbol"); require("core-js/modules/es.symbol.description"); require("core-js/modules/es.symbol.iterator"); require("core-js/modules/es.array.concat"); require("core-js/modules/es.array.iterator"); require("core-js/modules/es.object.get-prototype-of"); require("core-js/modules/es.object.set-prototype-of"); require("core-js/modules/es.object.to-string"); require("core-js/modules/es.string.iterator"); require("core-js/modules/web.dom-collections.iterator"); require("core-js/modules/web.timers"); exports.__esModule = true; exports.default = void 0; var _base = _interopRequireDefault(require("../_base")); var _plugins = require("../../plugins"); var _dataProvider = _interopRequireDefault(require("./dataProvider")); var _typeFactory = _interopRequireWildcard(require("./typeFactory")); function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; } function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); } function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } } function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; } function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); } function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; } function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); } function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); } function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); } /** * @plugin ExportFile * * @description * The plugin enables exporting table data to file. It allows to export data as a string, blob or a downloadable file in * CSV format. * * See [the export file demo](https://docs.handsontable.com/demo-export-file.html) for examples. * * @example * ```js * const container = document.getElementById('example'); * const hot = new Handsontable(container, { * data: getData() * }); * * // access to exportFile plugin instance * const exportPlugin = hot.getPlugin('exportFile'); * * // export as a string * exportPlugin.exportAsString('csv'); * * // export as a blob object * exportPlugin.exportAsBlob('csv'); * * // export to downloadable file (named: MyFile.csv) * exportPlugin.downloadFile('csv', {filename: 'MyFile'}); * * // export as a string (with specified data range): * exportPlugin.exportAsString('csv', { * exportHiddenRows: true, // default false * exportHiddenColumns: true, // default false * columnHeaders: true, // default false * rowHeaders: true, // default false * columnDelimiter: ';', // default ',' * range: [1, 1, 6, 6] // [startRow, endRow, startColumn, endColumn] * }); * ``` */ var ExportFile = /*#__PURE__*/ function (_BasePlugin) { _inherits(ExportFile, _BasePlugin); function ExportFile() { _classCallCheck(this, ExportFile); return _possibleConstructorReturn(this, _getPrototypeOf(ExportFile).apply(this, arguments)); } _createClass(ExportFile, [{ key: "isEnabled", /** * Checks if the plugin is enabled in the handsontable settings. This method is executed in {@link Hooks#beforeInit} * hook and if it returns `true` than the {@link ExportFile#enablePlugin} method is called. * * @returns {Boolean} */ value: function isEnabled() { return true; } /** * @typedef ExportOptions * @memberof ExportFile * @type {object} * @property {boolean} [exportHiddenRows=false] Include hidden rows in the exported file. * @property {boolean} [exportHiddenColumns=false] Include hidden columns in the exported file. * @property {boolean} [columnHeaders=false] Include column headers in the exported file. * @property {boolean} [rowHeaders=false] Include row headers in the exported file. * @property {string} [columnDelimiter=','] Column delimiter. * @property {string} [range=[]] Cell range that will be exported to file. */ /** * Exports table data as a string. * * @param {String} format Export format type eq. `'csv'`. * @param {ExportOptions} options Export options. */ }, { key: "exportAsString", value: function exportAsString(format) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; return this._createTypeFormatter(format, options).export(); } /** * Exports table data as a blob object. * * @param {String} format Export format type eq. `'csv'`. * @param {ExportOptions} options Export options. */ }, { key: "exportAsBlob", value: function exportAsBlob(format) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; return this._createBlob(this._createTypeFormatter(format, options)); } /** * Exports table data as a downloadable file. * * @param {String} format Export format type eq. `'csv'`. * @param {ExportOptions} options Export options. */ }, { key: "downloadFile", value: function downloadFile(format) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; var _this$hot = this.hot, rootDocument = _this$hot.rootDocument, rootWindow = _this$hot.rootWindow; var formatter = this._createTypeFormatter(format, options); var blob = this._createBlob(formatter); var URL = rootWindow.URL || rootWindow.webkitURL; var a = rootDocument.createElement('a'); var name = "".concat(formatter.options.filename, ".").concat(formatter.options.fileExtension); if (a.download !== void 0) { var url = URL.createObjectURL(blob); a.style.display = 'none'; a.setAttribute('href', url); a.setAttribute('download', name); rootDocument.body.appendChild(a); a.dispatchEvent(new MouseEvent('click')); rootDocument.body.removeChild(a); setTimeout(function () { URL.revokeObjectURL(url); }, 100); } else if (navigator.msSaveOrOpenBlob) { // IE10+ navigator.msSaveOrOpenBlob(blob, name); } } /** * Creates and returns class formatter for specified export type. * * @private * @param {String} format Export format type eq. `'csv'`. * @param {ExportOptions} options Export options. */ }, { key: "_createTypeFormatter", value: function _createTypeFormatter(format) { var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; if (!_typeFactory.EXPORT_TYPES[format]) { throw new Error("Export format type \"".concat(format, "\" is not supported.")); } return (0, _typeFactory.default)(format, new _dataProvider.default(this.hot), options); } /** * Creates blob object based on provided type formatter class. * * @private * @param {BaseType} typeFormatter * @returns {Blob} */ }, { key: "_createBlob", value: function _createBlob(typeFormatter) { var formatter = null; if (typeof Blob !== 'undefined') { formatter = new Blob([typeFormatter.export()], { type: "".concat(typeFormatter.options.mimeType, ";charset=").concat(typeFormatter.options.encoding) }); } return formatter; } }]); return ExportFile; }(_base.default); (0, _plugins.registerPlugin)('exportFile', ExportFile); var _default = ExportFile; exports.default = _default;