EmbeddedSpreadsheetOptions
EmbeddedSpreadsheetOptions interface
options for creating spreadsheet
Members
| add_tab | optional | boolean boolean | allow add/delete tab |
| chart_menu | optional | boolean boolean | include the chart menu in the toolbar |
| collapsed | optional | boolean boolean | start with sidebar closed. defaults to false. |
| complex | optional | enable handling complex numbers in function calculation. turning this off doesn't actually disable complex numbers. it means that functions will not return complex numbers unless one of the arguments is complex. | |
| constrain_width | optional | boolean boolean | even if we allow resizing, constrain width. this is to support fixed width columns. |
| container | optional | string | HTMLElement string | HTMLElement | containing HTML element |
| optional | boolean boolean | show delete tab (deprecated) | |
| dnd | optional | boolean boolean | allow drag-and-drop files |
| document | optional | string string | fetch network document. this is a replacement for the old (deprecated) option `network_document`. |
| expand | optional | boolean boolean | expandable grid. if this option is false, the grid will always stay the same size -- if you keep pressing down arrow, it won't grow. defaults to true. |
| expand_formula_button | optional | boolean boolean | expand formula bar |
| export | optional | boolean boolean | export to xlsx, now optional |
| file_menu | optional | boolean boolean | include the file menu in the toolbar |
| font_scale | optional | boolean boolean | include the font scale control in the toolbar |
| formula_bar | optional | boolean boolean | show formula bar. default true. |
| freeze_button | optional | boolean boolean | include the freeze button in the toolbar |
| freeze_columns | optional | number number | freeze columns |
| freeze_rows | optional | number number | freeze rows |
| global_name | optional | string string | set a reference in global (self) |
| headers | optional | boolean boolean | row/column headers |
| headless | optional | boolean boolean | better support for headless operations (default false) |
| hyperlinks | optional | string | false string | false | target window for hyperlinks (default _blank); set false to disable hyperlinks altogether |
| imaginary_value | optional | string string | for rendering the imaginary number. this is intended to support switching to a different character for rendering, or adding a leading space/half-space/hair-space. this _does_not_ change how you enter imaginary numbers, you still have to use `i` (lower-case ascii i). |
| in_cell_editor | optional | boolean boolean | support in-cell editor |
| indent_buttons | optional | boolean boolean | indent/outdent buttons; default false |
| language | optional | string string | language. at the moment this controls spreadsheet function names only; the plan is to expand to the rest of the interface over time. should be an ISO 639-1 language code, like "en", "fr" or "sv" (case insensitive). we only support a limited subset of languages at the moment. leave blank or set to "locale" to use the current locale. |
| local_storage | optional | string | boolean string | boolean | persist user changes to document in browser localStorage. if set to a string, the value is used as the storage key. if set to `true`, we will generate a storage key based on the page URI. don't do that if you have multiple spreadsheets on a single page, or they will overwrite each other. |
| markdown | optional | boolean boolean | support markdown formatting for text in cells and comments. at the moment we only support bold, italic, and strike text. |
| max_file_size | optional | number number | max size for image, in bytes |
| optional | string string | fetch network document (URI) (deprecated) | |
| persist_scale | optional | boolean | string boolean | string | save/load scale. this can optionally have a string key to disambiguate |
| prompt_save | optional | boolean boolean | prompt "you have unsaved changes" |
| recalculate | optional | boolean boolean | recalculate on load |
| recalculate_on_f9 | optional | boolean boolean | handle the F9 key and recalculate the spreadsheet. for compatibility. we're leaving this option to default `false` for now, but that may change in the future. key modifiers have no effect. |
| resizable | optional | boolean boolean | add resizable wrapper |
| revert_button | optional | boolean boolean | show the revert button in the sidebar. see the `Revert` method. this was renamed from `revert` to avoid any ambiguity. |
| revert_indicator | optional | boolean boolean | show the revert indicator. this is an indicator that shows on the top-left of the spreadsheet when a network document has local changes. |
| scale | optional | number number | initial scale |
| scale_control | optional | boolean boolean | show scale control (slider) under the spreadsheet. |
| scroll | optional | scroll to cell on load | |
| scrollbars | optional | boolean boolean | show scrollbars |
| sheet | optional | string string | sheet to show on load, overrides anything in the model |
| spill | optional | boolean boolean | enable spill arrays and spill references. this is on by default starting in 30.1.0. set to false to disable. |
| spinner | optional | boolean boolean | show a spinner for long-running operations |
| stats | optional | boolean boolean | show the stats panel under the spreadsheet. |
| optional | string | boolean string | boolean | key in localStorage for persisting document. (deprecated) | |
| tab_bar | optional | boolean | boolean | | show tab bar (multi sheet) |
| table_button | optional | boolean boolean | include the insert/remove table button in the toolbar |
| tint_theme_colors | optional | boolean boolean | show tinted colors in toolbar color dropdowns. as of version 25 this defaults to true (used to be false). |
| toll_initial_load | optional | boolean boolean | don't load immediately (?) |
| toolbar | optional | boolean | boolean | | toolbar display option. true or false means include/don't include the toolbar (and the toolbar button). setting to "narrow" means include the toolbar, but use a narrow version (it compresses the align/justify groups). the toolbar usually starts hidden. if you set this option to "show", it will start visible. same for "show-narrow". |
| toolbar_recalculate_button | optional | boolean boolean | include a recalculate button in the toolbar |
| undo | optional | boolean boolean | support undo |
Referenced by
| TREBGlobal.CreateSpreadsheet |
| EmbeddedSpreadsheet.LoadNetworkDocument |