TREBDocument
TREBDocument interface
this is the document type used by TREB. it has a lot of small variations for historical reasons and backwards compatibility. usually it’s preferable to let TREB create and manage these documents rather than creating them manually.
Members
active_sheet | optional | number number | active sheet. if unset we'll show the first un-hidden sheet |
app | string string | app name, as identifier | |
decimal_mark | optional | document decimal mark | |
macro_functions | optional | document macro functions | |
name | optional | string string | document name |
named | optional | new consolidated named ranges & expressions | |
named_expressions | optional | document named expressions @deprecated | |
named_ranges | optional | document named ranges @deprecated | |
rendered_values | optional | boolean boolean | this document includes rendered calculated values. using this lets the app show a document faster, without requiring an initial calculation. |
revision | optional | number number | revision number. this is a value that increments on any document change, useful for checking if a document is "dirty". |
shared_resources | optional | Record<string, string> Record<string, string> | document shared resources (usually images) |
sheet_data | optional | per-sheet data. this should be an array, but for historical reasons we still support a single sheet outside of an array. | |
tables | optional | document tables | |
user_data | optional | unknown unknown | opaque user data. we don't read or parse this, but applications can use it to store arbitrary data. |
version | string string | app version. we'll warn if you use a file from a newer version |
Referenced by
EmbeddedSpreadsheet.LoadDocument |
EmbeddedSpreadsheet.SerializeDocument |