@trebco/treb 23.4.0 → 23.6.0

package/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v23.4. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v23.6. 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
@@ -193,6 +193,7 @@ export declare class EmbeddedSpreadsheet {
      */
     InsertTable(range?: RangeReference, options?: InsertTableOptions): void;
     RemoveTable(range?: RangeReference): void;
+    UpdateTableStyle(range?: RangeReference, theme?: TableTheme | number): void;
 
     /**
      * Add a sheet, optionally named.
@@ -947,6 +948,33 @@ export interface DimensionedQuantity {
     unit: string;
 }
 
+/**
+ * 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;
+}
+
 /**
  * type represents a reference passed in to API functions. it can be an
  * address object, or a string.
@@ -994,6 +1022,7 @@ 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.
+     * defaults to true.
      */
     totals_row?: boolean;
 
@@ -1001,6 +1030,12 @@ export interface InsertTableOptions {
      * 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';
@@ -1171,6 +1206,9 @@ export interface EmbeddedSpreadsheetOptions {
     /** font size in the toolbar */
     font_scale?: boolean;
 
+    /** show insert/remove table button in toolbar */
+    table_button?: boolean;
+
     /** chart menu in the toolbar */
     chart_menu?: boolean;