Constructor
new module:caplin/grid/decorator/ContainerExportDecorator(decoratorConfig)
Decorator
ContainerExportDecorator
enable exporting of container
contents to CSV file Via eventhub
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
decoratorConfig |
object | |||
config.exportHiddenColumns |
boolean | |||
config.menuText |
string |
<optional> |
i18n("ct.grid.export.csv.menu.text") | |
decoratorConfig.excludedColumns |
string |
<optional> |
Methods
-
exportCSV()
-
Initiates the grid data file download in CSV format.
-
exportGrid()
-
Initiates the grid data file download in CSV format.
-
exportXLSX()
-
Initiates the grid data file download in XLSX format.
-
onRowDataUnavailable()
-
Disable the menu group representing export functionality when attempted communication with the server fails.
-
onSizeChanged()
-
Disable and enable the export functionality when the grid is empty and non-empty respectively.
-
setGridView(gridView)
-
Gets the gridView to determine row count of grid and componentAdaptor.
Parameters:
Name Type Description gridView
module:caplin/grid/GridView The grid to be exported via menu item.