File.export
Description
Exports and downloads data as Excel or CSV file.
Input / Parameter
Name | Description | Input Type | Default | Options | Required |
---|---|---|---|---|---|
data | The list of objects to be exported. Multiple dynamic attributes with values associated with each attribute. | List | - | - | Yes |
fileName | The name of the file that will be downloaded. | Text | - | - | Yes |
fileType | The type of file to create. | Text | Excel | Excel, CSV | Yes |
sheetName | The worksheet within the file to write data to. By default, the worksheet name will be 'Sheet 1'. | Text | - | - | No |
header | To denote whether the data has a header row. | Boolean | - | - | No |
extra | The stored value that is passed to all the callbacks. | Any | - | - | No |
Output
Description | Output Type |
---|---|
Returns the formatted information. | Object |
Object
Key | Description | Output Type |
---|---|---|
success | Boolean value to denote whether the function was executed successfully. | Text |
message | The message to print. | Text |
data | Any additional message or data to print. | Text |
Callback
callback
The action performed if this function runs successfully.
Description | Output Type |
---|---|
Returns an object that contains the file information. | Object |
errorCallback
The action performed if this function does not run successfully.
Description | Output Type |
---|---|
Returns an error message. | Text |
Video
Coming Soon.
Example
Coming Soon.
Steps
Coming Soon.
Result
Coming Soon.
Links
Last updated