@catull/igniteui-angular
Version:
Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps
116 lines • 11.9 kB
JavaScript
import { IgxExporterOptionsBase } from '../exporter-common/exporter-options-base';
/**
* Objects of this class are used to configure the CSV exporting process.
*/
export class IgxCsvExporterOptions extends IgxExporterOptionsBase {
constructor(fileName, fileType) {
super(fileName, IgxCsvExporterOptions.getExtensionFromFileType(fileType));
this.setFileType(fileType);
this.setDelimiter();
}
static getExtensionFromFileType(fType) {
let extension = '';
switch (fType) {
case CsvFileTypes.CSV:
extension = '.csv';
break;
case CsvFileTypes.TSV:
extension = '.tsv';
break;
case CsvFileTypes.TAB:
extension = '.tab';
break;
default:
throw Error('Unsupported CSV file type!');
}
return extension;
}
/**
* Gets the value delimiter which will be used for the exporting operation.
* ```typescript
* let delimiter = this.exportOptions.valueDelimiter;
* ```
* @memberof IgxCsvExporterOptions
*/
get valueDelimiter() {
return this._valueDelimiter;
}
/**
* Sets a value delimiter which will overwrite the default delimiter of the selected export format.
* ```typescript
* this.exportOptions.valueDelimiter = '|';
* ```
* @memberof IgxCsvExporterOptions
*/
set valueDelimiter(value) {
this.setDelimiter(value);
}
/**
* Gets the CSV export format.
* ```typescript
* let filetype = this.exportOptions.fileType;
* ```
* @memberof IgxCsvExporterOptions
*/
get fileType() {
return this._fileType;
}
/**
* Sets the CSV export format.
* ```typescript
* this.exportOptions.fileType = CsvFileTypes.TAB;
* ```
* @memberof IgxCsvExporterOptions
*/
set fileType(value) {
this.setFileType(value);
}
setFileType(value) {
if (value !== undefined && value !== null && value !== this._fileType) {
this._fileType = value;
const extension = IgxCsvExporterOptions.getExtensionFromFileType(value);
if (!this.fileName.endsWith(extension)) {
const oldExt = '.' + this.fileName.split('.').pop();
const newName = this.fileName.replace(oldExt, extension);
this._fileExtension = extension;
this.fileName = newName;
}
}
}
setDelimiter(value) {
if (value !== undefined && value !== '' && value !== null) {
this._valueDelimiter = value;
}
else {
switch (this.fileType) {
case CsvFileTypes.CSV:
this._valueDelimiter = ',';
break;
case CsvFileTypes.TSV:
case CsvFileTypes.TAB:
this._valueDelimiter = '\t';
break;
}
}
}
}
/**
* This enumeration is used to configure the default value separator
* as well as the default file extension used when performing CSV exporting.
*/
export var CsvFileTypes;
(function (CsvFileTypes) {
/**
* Character Separated Values, default separator is "comma", default file extension is .csv
*/
CsvFileTypes[CsvFileTypes["CSV"] = 0] = "CSV";
/**
* Tab Separated Values, default separator is tab, default file extension is .tsv
*/
CsvFileTypes[CsvFileTypes["TSV"] = 1] = "TSV";
/**
* Tab Separated Values, default separator is tab, default file extension is .tab
*/
CsvFileTypes[CsvFileTypes["TAB"] = 2] = "TAB";
})(CsvFileTypes || (CsvFileTypes = {}));
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"csv-exporter-options.js","sourceRoot":"ng://igniteui-angular/","sources":["lib/services/csv/csv-exporter-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAElF;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,sBAAsB;IAK7D,YAAY,QAAgB,EAAE,QAAsB;QAChD,KAAK,CAAC,QAAQ,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC3B,IAAI,CAAC,YAAY,EAAE,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,KAAmB;QACvD,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,QAAQ,KAAK,EAAE;YACX,KAAK,YAAY,CAAC,GAAG;gBACjB,SAAS,GAAG,MAAM,CAAC;gBACnB,MAAM;YACV,KAAK,YAAY,CAAC,GAAG;gBACjB,SAAS,GAAG,MAAM,CAAC;gBACnB,MAAM;YACV,KAAK,YAAY,CAAC,GAAG;gBACjB,SAAS,GAAG,MAAM,CAAC;gBACnB,MAAM;YACV;gBACI,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;SACjD;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,IAAI,cAAc;QACd,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,IAAI,cAAc,CAAC,KAAK;QACpB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ,CAAC,KAAK;QACd,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAEO,WAAW,CAAC,KAAK;QACrB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,EAAE;YACnE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,MAAM,SAAS,GAAG,qBAAqB,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBACpC,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;gBACpD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBACzD,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;gBAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;aAC3B;SACJ;IACL,CAAC;IAEO,YAAY,CAAC,KAAM;QACvB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,IAAI,EAAE;YACvD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;SAChC;aAAM;YACH,QAAQ,IAAI,CAAC,QAAQ,EAAE;gBACnB,KAAK,YAAY,CAAC,GAAG;oBACjB,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;oBAC3B,MAAM;gBACV,KAAK,YAAY,CAAC,GAAG,CAAC;gBACtB,KAAK,YAAY,CAAC,GAAG;oBACjB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;oBAC5B,MAAM;aACb;SACJ;IACL,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,YAaX;AAbD,WAAY,YAAY;IACpB;;OAEG;IACH,6CAAG,CAAA;IACH;;OAEG;IACH,6CAAG,CAAA;IACH;;OAEG;IACH,6CAAG,CAAA;AACP,CAAC,EAbW,YAAY,KAAZ,YAAY,QAavB","sourcesContent":["import { IgxExporterOptionsBase } from '../exporter-common/exporter-options-base';\n\n/**\n * Objects of this class are used to configure the CSV exporting process.\n */\nexport class IgxCsvExporterOptions extends IgxExporterOptionsBase {\n\n    private _valueDelimiter;\n    private _fileType;\n\n    constructor(fileName: string, fileType: CsvFileTypes) {\n        super(fileName, IgxCsvExporterOptions.getExtensionFromFileType(fileType));\n        this.setFileType(fileType);\n        this.setDelimiter();\n    }\n\n    private static getExtensionFromFileType(fType: CsvFileTypes) {\n        let extension = '';\n        switch (fType) {\n            case CsvFileTypes.CSV:\n                extension = '.csv';\n                break;\n            case CsvFileTypes.TSV:\n                extension = '.tsv';\n                break;\n            case CsvFileTypes.TAB:\n                extension = '.tab';\n                break;\n            default:\n                throw Error('Unsupported CSV file type!');\n        }\n        return extension;\n    }\n\n    /**\n     * Gets the value delimiter which will be used for the exporting operation.\n     * ```typescript\n     * let delimiter = this.exportOptions.valueDelimiter;\n     * ```\n     * @memberof IgxCsvExporterOptions\n     */\n    get valueDelimiter() {\n        return this._valueDelimiter;\n    }\n\n    /**\n     * Sets a value delimiter which will overwrite the default delimiter of the selected export format.\n     * ```typescript\n     * this.exportOptions.valueDelimiter = '|';\n     * ```\n     * @memberof IgxCsvExporterOptions\n     */\n    set valueDelimiter(value) {\n        this.setDelimiter(value);\n    }\n\n    /**\n     * Gets the CSV export format.\n     * ```typescript\n     * let filetype = this.exportOptions.fileType;\n     * ```\n     * @memberof IgxCsvExporterOptions\n     */\n    get fileType() {\n        return this._fileType;\n    }\n\n    /**\n     * Sets the CSV export format.\n     * ```typescript\n     * this.exportOptions.fileType = CsvFileTypes.TAB;\n     * ```\n     * @memberof IgxCsvExporterOptions\n     */\n    set fileType(value) {\n        this.setFileType(value);\n    }\n\n    private setFileType(value) {\n        if (value !== undefined && value !== null && value !== this._fileType) {\n            this._fileType = value;\n            const extension = IgxCsvExporterOptions.getExtensionFromFileType(value);\n            if (!this.fileName.endsWith(extension)) {\n                const oldExt = '.' + this.fileName.split('.').pop();\n                const newName = this.fileName.replace(oldExt, extension);\n                this._fileExtension = extension;\n                this.fileName = newName;\n            }\n        }\n    }\n\n    private setDelimiter(value?) {\n        if (value !== undefined && value !== '' && value !== null) {\n            this._valueDelimiter = value;\n        } else {\n            switch (this.fileType) {\n                case CsvFileTypes.CSV:\n                    this._valueDelimiter = ',';\n                    break;\n                case CsvFileTypes.TSV:\n                case CsvFileTypes.TAB:\n                    this._valueDelimiter = '\\t';\n                    break;\n            }\n        }\n    }\n}\n\n/**\n * This enumeration is used to configure the default value separator\n * as well as the default file extension used when performing CSV exporting.\n */\nexport enum CsvFileTypes {\n    /**\n     * Character Separated Values, default separator is \"comma\", default file extension is .csv\n     */\n    CSV,\n    /**\n     * Tab Separated Values, default separator is tab, default file extension is .tsv\n     */\n    TSV,\n    /**\n     * Tab Separated Values, default separator is tab, default file extension is .tab\n     */\n    TAB\n}\n"]}