import Exporter from 'flexicious-react-datagrid/js/flexgrid/export/Exporter.js'Exporter
Extends:
Direct Subclass:
Indirect Subclass:
psuedo abstract class responsible for most export functionality.
Static Method Summary
| Static Public Methods | ||
| public static |
getColumnHeader(col: *, colIndex: *): * Gets the header for the row |
|
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Public Members | ||
| public |
allRecords: *[] |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
|
|
Method Summary
| Public Methods | ||
| 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 |
|
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. |
|
Static Public Methods
public static getColumnHeader(col: *, colIndex: *): * source
Gets the header for the row
Params:
| Name | Type | Attribute | Description |
| col | * | ||
| colIndex | * |
Return:
| * |
Public Constructors
Public Methods
public getClassNames(): string[] source
Returns a list of strings that represent the object hierarchy for this object.
Override:
TypedObject#getClassNamespublic getContentType(): String source
Returns the content type so the appropriate application launches when the exporter is run.
public getSpaces(col: *, spChar: *): String source
Depending on the level, gets indentation spaces
Params:
| Name | Type | Attribute | Description |
| col | * | ||
| spChar | * |
public isIncludedInExport(col: *): Boolean | * source
Checks whether this column should be exported
Params:
| Name | Type | Attribute | Description |
| col | * |
public saveFile(body: *, fileName: *, exportOptions: *): * source
Saves the file to disk, or sends it to a remote server to buffer back.
Params:
| Name | Type | Attribute | Description |
| body | * | ||
| fileName | * | ||
| exportOptions | * |
Return:
| * |
public uploadForEcho(body: *, exportOptions: *) source
Just in case in the client wants to customize the upload behavior of their exporters.
Params:
| Name | Type | Attribute | Description |
| body | * | ||
| exportOptions | * |
public uploadToServer(body: *, exportOptions: *) source
Not used
Params:
| Name | Type | Attribute | Description |
| body | * | ||
| exportOptions | * |
public writeFooter(grid: *, dataProvider: *): String source
Writes out the footer for the row
Params:
| Name | Type | Attribute | Description |
| grid | * | ||
| dataProvider | * |