@trebco/treb 23.3.3 → 23.5.1

package/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v23.3. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v23.5. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /** 
  * Global instance. In the base script, this object will be created as an
@@ -184,6 +184,16 @@ export declare class EmbeddedSpreadsheet {
      */
     GetSheetID(sheet: string | number): number | undefined;
 
+    /**
+     * insert a table in the given range. optionally include a totals row.
+     * this method does not make any changes to content or layout. it just
+     * converts the range to a table.
+     *
+     * @param reference
+     */
+    InsertTable(range?: RangeReference, options?: InsertTableOptions): void;
+    RemoveTable(range?: RangeReference): void;
+
     /**
      * Add a sheet, optionally named.
      */
@@ -968,6 +978,111 @@ export interface TableSortOptions {
     asc: boolean;
 }
 export type TableSortType = 'text' | 'numeric' | 'auto';
+export declare type LoadSource = "drag-and-drop" | "local-file" | "network-file" | "local-storage" | "undo";
+
+/**
+ * EmbeddedSheetEvent is a discriminated union. Switch on the `type` field
+ * of the event.
+ */
+export type EmbeddedSheetEvent = DocumentChangeEvent | DocumentResetEvent | DocumentLoadEvent | DataChangeEvent | SelectionEvent | ResizeEvent;
+
+/**
+ * options when inserting a table into a sheet
+ */
+export interface InsertTableOptions {
+
+    /**
+     * include a totals/summation row. this impacts the layout and styling:
+     * totals row have a unique style and are not included when sorting.
+     */
+    totals_row?: boolean;
+
+    /**
+     * show a sort button in table headers. defaults to true.
+     */
+    sortable?: boolean;
+
+    /**
+     * base theme color, or a set of styles for the table. useful values for
+     * theme color are accent colors 4 (the default), 5, 7 and 9.
+     */
+    theme?: number | TableTheme;
+}
+export interface ResizeEvent {
+    type: 'resize';
+}
+export declare type LoadType = "treb" | "csv" | "xlsx";
+
+/**
+ * This event is sent when a document is loaded, and also on undo. The
+ * source field can help determine if it was triggered by an undo operation.
+ */
+export interface DocumentLoadEvent {
+    type: 'load';
+    source?: LoadSource;
+    file_type?: LoadType;
+}
+
+/**
+ * This event is sent when the document is reset.
+ *
+ **/
+export interface DocumentResetEvent {
+    type: 'reset';
+}
+
+/**
+ * This event is sent when data in the spreadsheet changes, but there are
+ * no structural or cell changes. For example, the `RAND` function returns
+ * a new value on every calculation, but the function itself does not change.
+ */
+export interface DataChangeEvent {
+    type: 'data';
+}
+
+/**
+ * This event is sent when the value of a cell changes, or when the document
+ * structure chages. Structure changes might be inserting/deleting rows or
+ * columns, or adding/removing a sheet.
+ */
+export interface DocumentChangeEvent {
+    type: 'document-change';
+}
+
+/**
+ * This event is sent when the spreadsheet selection changes. Use the
+ * `GetSelection` method to get the address of the current selection.
+ */
+export interface SelectionEvent {
+    type: 'selection';
+}
+
+/**
+ * composite styling for tables.
+ *
+ **/
+export interface TableTheme {
+
+    /** the first row in a table, showing column titles. */
+    header?: Style.Properties;
+
+    /**
+     * odd rows in the table. we count the title row as zero, so
+     * the first row in the table containing data is 1, hence odd.
+     */
+    odd?: Style.Properties;
+
+    /**
+     * even rows in the table.
+     */
+    even?: Style.Properties;
+
+    /**
+     * styling for the totals row, if included. this will be the last
+     * row in the table.
+     */
+    total?: Style.Properties;
+}
 
 /**
  * options for exporting CSV/TSV
@@ -1158,61 +1273,6 @@ export interface EmbeddedSpreadsheetOptions {
      */
     revert?: boolean;
 }
-export declare type LoadSource = "drag-and-drop" | "local-file" | "network-file" | "local-storage" | "undo";
-
-/**
- * EmbeddedSheetEvent is a discriminated union. Switch on the `type` field
- * of the event.
- */
-export type EmbeddedSheetEvent = DocumentChangeEvent | DocumentResetEvent | DocumentLoadEvent | DataChangeEvent | SelectionEvent | ResizeEvent;
-export interface ResizeEvent {
-    type: 'resize';
-}
-export declare type LoadType = "treb" | "csv" | "xlsx";
-
-/**
- * This event is sent when a document is loaded, and also on undo. The
- * source field can help determine if it was triggered by an undo operation.
- */
-export interface DocumentLoadEvent {
-    type: 'load';
-    source?: LoadSource;
-    file_type?: LoadType;
-}
-
-/**
- * This event is sent when the document is reset.
- *
- **/
-export interface DocumentResetEvent {
-    type: 'reset';
-}
-
-/**
- * This event is sent when data in the spreadsheet changes, but there are
- * no structural or cell changes. For example, the `RAND` function returns
- * a new value on every calculation, but the function itself does not change.
- */
-export interface DataChangeEvent {
-    type: 'data';
-}
-
-/**
- * This event is sent when the value of a cell changes, or when the document
- * structure chages. Structure changes might be inserting/deleting rows or
- * columns, or adding/removing a sheet.
- */
-export interface DocumentChangeEvent {
-    type: 'document-change';
-}
-
-/**
- * This event is sent when the spreadsheet selection changes. Use the
- * `GetSelection` method to get the address of the current selection.
- */
-export interface SelectionEvent {
-    type: 'selection';
-}
 
 /**
  * options for the evaluate function