@trebco/treb 21.3.1 → 21.6.0

package/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v21.3. Copyright 2018-2022 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v21.6. Copyright 2018-2022 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /** 
  * Global instance. In the base script, this object will be created as an
@@ -341,6 +341,16 @@ export declare class EmbeddedSpreadsheet {
      */
     UnmergeCells(range?: RangeReference): void;
 
+    /**
+     * revert to the original version of this document. this is a new flow
+     * that requires options set for `storage_key` and `alternate_document`.
+     *
+     * the idea is that the localStorage version will control, unless you
+     * don't have one or you revert; in that case we will load the alternate
+     * document.
+     */
+    Revert(): void;
+
     /**
      * Export to XLSX file.
      *
@@ -606,13 +616,22 @@ export declare class EmbeddedSpreadsheet {
     ClearName(name: string): void;
 
     /**
-     * Create a named range.
+     * Create a named range or named expression. A named range refers to an
+     * address or range. A named expression can be a value or formula, basically
+     * anything you would type into a cell.
+     *
+     * @param value range, value or expression
      *
-     * @param range leave undefined to use current selection
+     * @remarks
+     *
+     * This function used to support passing `undefined` as the value,
+     * which meant "create a named range using current selection". We don't
+     * support that any more but you can accompilsh that with
+     * `sheet.DefineName("Name", sheet.GetSelection())`.
      *
      * @public
      */
-    DefineName(name: string, range?: RangeReference): void;
+    DefineName(name: string, value: RangeReference | CellValue): void;
 
     /**
      * Set or remove a link in a cell.
@@ -1025,6 +1044,11 @@ export interface EmbeddedSpreadsheetOptions {
 
     /** collapsed: start sidebar closed */
     collapsed?: boolean;
+
+    /**
+     * show the revert button. see the Revert method.
+     */
+    revert?: boolean;
 }
 export declare type LoadSource = "drag-and-drop" | "local-file" | "network-file" | "local-storage" | "undo";