ng-rich-json-csv-parser
Ngx-rich-json-csv-parser help you to convert JSON to CSV file and Download it in the .csv format.
Features
- Convert JSON to CSV
- Download JSON data in CSV format file.
- Insert serial number
- Customize CSV file Header text
- Sort the CSV file data based on Header text
- Customize CSV file name
License
MIT
Installation
Start by installing the Angular Rich JSON CSV Parser library from npm
npm i -s ngx-rich-json-csv-parser
Next, you’ll need to import the NgxRichJsonCsvParserModule module in your app’s module.
To download JSON data as a CSV file format, use downloadFile() function
this._ngxRichJsonCsvParserService.downloadFile(< your Serial Number Header Name>, < Sort Header list>, );
Argument Details
| Order | Name | Type | Details |
|---|---|---|---|
| 1 | JSON Data | An array of objects | JSON data which is used to convert into CSV |
| 2 | Custom Header | An array of String | You can provide custom csv header name, please note number of element in this header array should be equal to number of property in single JSON array object data |
| 3 | isAutoGenerateSlNo(IsGenerateSerial Number) | Boolean | This flag is used to generate Numerical serial number start from 1 |
| 4 | CSV File Name | string | Your custom CSV file name |
| 5 | Serial Number header name | string | If isAutoGenerateSlNo is true then you can provide custom header for Serial number |
| 6 | Sort CSV Header list | enum | To sort CSV Header list, available options are – without Sorting : HeaderSortMode.NONE – to sort ascending order: HeaderSortMode.ASC – to sort descending order: HeaderSortMode.DESC |
| 7 | Header Text format | enum | To format CSV all header text to uppercase or lowercase or capitalize or startcase(title case) eg: HeaderCaseMode.StartCase |
To convert JSON to CSV data format without downloading, use ConvertToCSV() function,
this._ngxRichJsonCsvParserService.ConvertToCSV(this.jsonData, [], true, ‘mySl’, HeaderSortMode.DESC, HeaderCaseMode.StartCase); // this function returns csv data
Argument details
| Order | Name | Type | Details |
|---|---|---|---|
| 1 | JSON Data | An array of objects | JSON data which is used to convert into CSV |
| 2 | Custom Header | An array of String | You can provide custom csv header name, please note number of element in this header array should be equal to number of property in single JSON array object data |
| 3 | isAutoGenerateSlNo(IsGenerateSerial Number) | Boolean | This flag is used to generate Numerical serial number start from 1 |
| 4 | Serial Number header name | string | If isAutoGenerateSlNo is true then you can provide custom header for Serial number |
| 5 | Sort CSV Header list | enum | To sort CSV Header list, available options are – without Sorting : HeaderSortMode.NONE – to sort ascending order: HeaderSortMode.ASC – to sort descending order: HeaderSortMode.DESC |
| 6 | Header Text format | enum | To format CSV all header text to uppercase or lowercase or capitalize or startcase(title case) eg: HeaderCaseMode.StartCase |
Github: