-
Notifications
You must be signed in to change notification settings - Fork 160
CSV Exporter Service Specification
Character separated values formats allow storing tabular data in plain text. A file in such a format consists of lines. Each line is a data record and each record consists of one or more fields separated from each other by a certain character. Files of this format are generally used for exchanging data between programs operating on incompatible formats.
Provide an option to export IgniteUI for Angular Grid component to a character separated values format. By default the resulting text file will fully represent the exported grid, meaning that it will contain the data from all the columns and rows visible to the end user, in the order they are shown. All the filtered out and hidden rows and columns shouldn't be a part of the exported file.
However, we will also allow the developers to specify whether they want to honor of ignore certain features when exporting the grid. The developers will also be able to prevent the exporting of columns and rows that are visible in the grid and change exported values.
Another option available to the developer will be to export arrays with homogeneous object, string, number or date data.
We will only support ".csv", ".tsv" and ".tab" file formats and the exporter will always create a new file with the exported data.
As a developer, I want to provide options for exporting the IgxGridComponent. As a developer, I want to be able to specify a delimiter different from "," and "\t". As a developer, I want to be able to control which columns and rows are exported with options to change the exported data. As a developer, I want additional features that affect the UI of the grid to also be reflected in the exported data. As a developer, I want to be able to export homogeneous array data.
As an end user, I want to be able to export the grid I am working on directly to plain text. As an end user, I want the exported grid data to closely represent the grid shown on the screen.
Be able to export the IgxGrid and the resulting file to closely represent the grid. Be able to prevent any column or row from exporting. Be able to export homogeneous array data.
The exporter will provide means of exporting the IgxGrid to .csv, .tsv and .tab files. The format of the current implementation is as follows:
- Each record in the result file will be located on a separate line, delimited by a line break (CRLF).
- The last record in the file also has an ending line break.
- A header line will appear as the first line of the file with the same format as the data records' lines. The header line will contain the names of the corresponding fields or a default field name when exporting homogeneous data array.
- Within all records there may be one or more fields, separated by the specified delimiter. The last field in the record will not be followed by the delimiter.
- Fields, containing line breaks (CR, LF, CRLF) or the delimiter character, will be enclosed in double-quotes.
RFC 4180 (https://tools.ietf.org/html/rfc4180)
The user will not be directly aware of the existence of the exporter as it will have no UI. They will be able to export the grid through button clicks or other means provided by the developer.
The exporter is a service, injectable into the component that is being developed. From there the developer may call the export methods of the service to export their igxGrid or array data. The exporter will also need an IgxCsvExporterOptions object to be provided. The IgxCsvExporterOptions will require a name for the resulting file and a CsvFileType format, but it will also have properties that can be used to modify the exported data, such as whether hidden columns or filtered out rows should be exported. We will also provide cancelable events for RowExporting and ColumnExporting in which, if canceled, will prevent the row/column from exporting.
The exporter will be able to export grids/data that contains non Latin characters.
There is no user interface for this feature.