| layout | title | description | group |
|---|---|---|---|
docs |
Index |
Index page for Export Sheet Data's documentation. |
overview |
Here you can find detailed descriptions for each of ESD's various options and settings, as well as a few guidelines for how to properly use ESD.
This documentation is still being written, so please bear with us and forgive any missing content while it is being completed.
1. Format Settings
2. General Settings
3. JSON Settings
4. XML Settings
5. Tips & Tricks
These settings determine which format (JSON or XML) to export your data to, as well as the target sheets to export.
- Export Format - Data format to export to (JSON or XML)
- Export Folder - Data folder to export files to
- Export Sheet(s) - Sheet tabs to include in the exported data
These settings affect both JSON and XML data.
- Replace existing file(s) - Trash files with the same name in the output folder as the exported data
- Unwrap single row sheets - Place elements from a sheet containing one row in the root element
- Collapse single row sheets - Place a sheet's only row element fields in the sheet element
- Ignore empty cells - Don't export cells with no value
- Nested Elements - Create complex data sets by using specific key syntax
- Minify data - Output smaller files at the cost of human readability
- Include first column in export - Export the first column of a row as a distinct element
- Ignore prefix - Don't export columns whose keys start with a specific prefix
- Unwrap prefix - Unwrap sheets with names using the specified prefix
- Collapse prefix - Collapse sheets with names using the specified prefix
These settings only affect exported JSON data.
- Force string values - Export all values as their string version
- Export cell arrays - Export JSON arrays when a cell contains a specific character
- Export sheet arrays - Export sheets as JSON arrays with each row creating a single element
- Export value arrays - Export a sheet as a JSON array if it has only one column
- Export contents as array - Convert exported standalone JSON to a raw JSON array
- Export cell objects - Export a cell's value as a JSON object or array if it is properly formatted
- Empty value format - Determines if empty cells are exported with null or empty string values
- Null value format - Determines if cells with the string "null" are exported with null or string values
- Array separator character - Adjust the character used to separate values in a cell array
- Array prefix - Force sheets or elements in a column to export as JSON arrays
- Nested array prefix - With Nested Elements checked, force sheets to export as nested arrays
These settings only affect exported XML data.
- Export columns as child elements - Export columns as child elements of their row's XML element
- Export bools as ints - Export boolean values as integers
- Root element - Name for the exported XML document's root element
- Name replacement character - Character used when replacing illegal chars in element names
- Include XML declaration- Include a customized XML declaration in the exported document
- XML version - Version of the XML standard used by the exported document
- XML encoding - Encoding used by the exported document
- Standalone - Specifies if the exported document depends on external resources
- Attributes prefix - Force elements in a column to export as attributes for their row element
- Child elements prefix - Force elements in a column to export as child elements of their row element
- Inner text prefix - Force elements in a column to export as inner text for their row element
- Root namespace URI - Root namespace for the XML document.
- Namespaces - Namespaces used in the XML document's elements.
These pages detail various tips for more obscure or esoteric functionality in ESD.
- Importing/Exporting Settings - Exporting or importing ESD settings from another document
- XML - Tips for the XML export format