@trebco/treb 23.1.2 → 23.1.7

package/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v23.1. Copyright 2018-2022 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v23.1. 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
@@ -94,7 +94,7 @@ export interface SheetScrollOptions {
 /**
  * function type used for filtering tables
  */
-export declare type TableFilterFunction = (value: CellValue, calculated_value: CellValue, style: Style.Properties) => boolean;
+export type TableFilterFunction = (value: CellValue, calculated_value: CellValue, style: Style.Properties) => boolean;
 
 /**
  * embedded spreadsheet
@@ -315,7 +315,7 @@ export declare class EmbeddedSpreadsheet {
     DeleteColumns(start_column?: number, count?: number): void;
 
     /**
-     * sort a table. the reference can be the table name, or a cell in the table.
+     * filter a table. the reference can be the table name, or a cell in the table.
      * if the reference is an area (range), we're going to look at the top-left
      * cell.
      *
@@ -920,7 +920,7 @@ export declare namespace Style {
         locked?: boolean;
     }
 }
-export declare type CellValue = undefined | string | number | boolean | Complex | DimensionedQuantity;
+export type CellValue = undefined | string | number | boolean | Complex | DimensionedQuantity;
 
 /**
  * Complex number type
@@ -938,13 +938,13 @@ export interface DimensionedQuantity {
  * type represents a reference passed in to API functions. it can be an
  * address object, or a string.
  */
-export declare type AddressReference = string | ICellAddress;
+export type AddressReference = string | ICellAddress;
 
 /**
  * type represents a reference passed in to API functions. it can be an
  * address object, an area (range) object, or a string.
  */
-export declare type RangeReference = string | ICellAddress | IArea;
+export type RangeReference = string | ICellAddress | IArea;
 export interface TableSortOptions {
 
     /**
@@ -954,13 +954,17 @@ export interface TableSortOptions {
      */
     column: number;
 
-    /** sort type. defaults to 'text'. */
+    /**
+     * sort type. defaults to 'auto'. 'auto' looks at the values in the column,
+     * and uses text sort if there are more strings, or numeric if there are
+     * more numbers. if it's even, sorts as text.
+     */
     type: TableSortType;
 
     /** ascending sort. defaults to true. */
     asc: boolean;
 }
-export declare type TableSortType = 'text' | 'numeric';
+export type TableSortType = 'text' | 'numeric' | 'auto';
 
 /**
  * options for exporting CSV/TSV
@@ -1157,7 +1161,7 @@ export declare type LoadSource = "drag-and-drop" | "local-file" | "network-file"
  * EmbeddedSheetEvent is a discriminated union. Switch on the `type` field
  * of the event.
  */
-export declare type EmbeddedSheetEvent = DocumentChangeEvent | DocumentResetEvent | DocumentLoadEvent | DataChangeEvent | SelectionEvent | ResizeEvent;
+export type EmbeddedSheetEvent = DocumentChangeEvent | DocumentResetEvent | DocumentLoadEvent | DataChangeEvent | SelectionEvent | ResizeEvent;
 export interface ResizeEvent {
     type: 'resize';
 }