import CsvExporter from 'flexicious-react-datagrid/js/flexgrid/export/CsvExporter.js'Method Summary
| Public Methods | ||
| public |
buildHeader(grid: *): String Builds the CSV representation of a header row. |
|
| public |
Escapes CSV characters to make valid CSV string |
|
| public |
getClassNames(): string[] |
|
| public |
Returns the content type so MS Excel launches when the exporter is run. |
|
| public |
Extension of the download file. |
|
| public |
Name of the exporter |
|
| public |
writeFooter(grid: *, dataProvider: *): String CsvExporter.SCIENTIFIC_NOTATION_THRESHOLD=1000000; Writes the footer in CSV format |
|
| public |
writeHeader(grid: *): String Writes the header of the grid (columns) in csv format |
|
| public |
writeRecord(grid: *, record: *): String Writes an individual record in csv format |
|
Inherited Summary
| From class TypedObject | ||
| public |
typeCache: {} |
|
| public |
|
|
| public |
Returns a list of strings that represent the object hierarchy for this object. |
|
| public |
implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class. |
|
| From class Exporter | ||
| public static |
getColumnHeader(col: *, colIndex: *): * Gets the header for the row |
|
| public |
allRecords: *[] |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
getClassNames(): string[] |
|
| public |
Returns the content type so the appropriate application launches when the exporter is run. |
|
| public |
Extension of the download file. |
|
| public |
Name of the exporter |
|
| public |
The current nest depth of the record being exported |
|
| public |
The nest indent on basis of the nest depth |
|
| public |
Depending on the level, gets indentation spaces |
|
| public |
isIncludedInExport(col: *): Boolean | * Checks whether this column should be exported |
|
| public |
saveFile(body: *, fileName: *, exportOptions: *): * Saves the file to disk, or sends it to a remote server to buffer back. |
|
| public |
uploadForEcho(body: *, exportOptions: *) Just in case in the client wants to customize the upload behavior of their exporters. |
|
| public |
uploadToServer(body: *, exportOptions: *) Not used |
|
| public |
writeFooter(grid: *, dataProvider: *): String Writes out the footer for the row |
|
| public |
writeHeader(grid: *): String Writes out the header for the row |
|
| public |
writeRecord(grid: *, record: *): String Writes out the record for the row |
|
Public Methods
public buildHeader(grid: *): String source
Builds the CSV representation of a header row.
Params:
| Name | Type | Attribute | Description |
| grid | * |
public escapeCsv(val: *): String | XML source
Escapes CSV characters to make valid CSV string
Params:
| Name | Type | Attribute | Description |
| val | * |
public getClassNames(): string[] source
Returns a list of strings that represent the object hierarchy for this object.
Override:
Exporter#getClassNamespublic getContentType(): String source
Returns the content type so MS Excel launches when the exporter is run.
Override:
Exporter#getContentTypepublic writeFooter(grid: *, dataProvider: *): String source
CsvExporter.SCIENTIFIC_NOTATION_THRESHOLD=1000000; Writes the footer in CSV format
Override:
Exporter#writeFooterParams:
| Name | Type | Attribute | Description |
| grid | * | ||
| dataProvider | * |
public writeHeader(grid: *): String source
Writes the header of the grid (columns) in csv format
Override:
Exporter#writeHeaderParams:
| Name | Type | Attribute | Description |
| grid | * |
public writeRecord(grid: *, record: *): String source
Writes an individual record in csv format
Override:
Exporter#writeRecordParams:
| Name | Type | Attribute | Description |
| grid | * | ||
| record | * |