@trebco/treb 22.14.2 → 23.1.0

package/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v22.14. Copyright 2018-2022 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v23.1. 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
@@ -309,6 +309,13 @@ export declare class EmbeddedSpreadsheet {
      */
     DeleteColumns(start_column?: number, count?: number): void;
 
+    /**
+     * sort a table. the cell reference can be anywhere in the table.
+     * if the reference is an area (range), we're going to look at the
+     * top-left cell.
+     */
+    SortTable(reference: RangeReference, options?: Partial<TableSortOptions>): void;
+
     /**
      * Merge cells in range.
      *
@@ -700,6 +707,12 @@ export interface SerializeOptions {
 
     /** prune unused rows/columns */
     shrink?: boolean;
+
+    /**
+     * include tables. tables will be serialized in the model, so we can
+     * drop them from cells. but you can leave them in if that's useful.
+     */
+    tables?: boolean;
 }
 
 /**
@@ -908,6 +921,22 @@ export declare type AddressReference = string | ICellAddress;
  * address object, an area (range) object, or a string.
  */
 export declare type RangeReference = string | ICellAddress | IArea;
+export interface TableSortOptions {
+
+    /**
+     * when sorting, column is relative to the table (and 0-based). so the
+     * first column in the table is 0, regardless of where the table is in
+     * the spreadsheet. defaults to 0, if not specified.
+     */
+    column: number;
+
+    /** sort type. defaults to 'text'. */
+    type: TableSortType;
+
+    /** ascending sort. defaults to true. */
+    asc: boolean;
+}
+export declare type TableSortType = 'text' | 'numeric';
 
 /**
  * options for exporting CSV/TSV
@@ -1056,6 +1085,24 @@ export interface EmbeddedSpreadsheetOptions {
     /** target window for hyperlinks (default _blank); set false to disable hyperlinks altogether */
     hyperlinks?: string | false;
 
+    /**
+     * 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.
+     *
+     * for example, if complex numbers are off, `=SQRT(-1)` will return `#VALUE`.
+     * if complex numbers are on, `=SQRT(-1)` will return `i`.
+     *
+     * even if complex numbers are off, however, `=SQRT(-1 + 0i)` will return
+     * `i` because the argument is complex.
+     *
+     * currently this behavior applies to `SQRT`, `POWER` and the exponentiation
+     * operator `^`.
+     *
+     * in version 22, this defaults to `off`.
+     */
+    complex?: 'on' | 'off';
+
     /**
      * for rendering the imaginary number. this is intended to support
      * switching to a different character for rendering, or adding a leading