@trebco/treb 23.1.0 → 23.1.3

package/treb.d.ts

@@ -91,6 +91,11 @@ export interface SheetScrollOptions {
     smooth?: boolean;
 }
 
+/**
+ * function type used for filtering tables
+ */
+export type TableFilterFunction = (value: CellValue, calculated_value: CellValue, style: Style.Properties) => boolean;
+
 /**
  * embedded spreadsheet
  */
@@ -310,9 +315,28 @@ 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.
+     * 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.
+     *
+     * this method uses a function to filter rows based on cell values. leave the
+     * function undefined to show all rows. this is a shortcut for "unfilter".
+     *
+     * @param column - the column to sort on. values from this column will be
+     * passed to the filter function.
+     *
+     * @param filter - a callback function to filter based on cell values. this
+     * will be called with the cell value (formula), the calculated value (if any),
+     * and the cell style. return false to hide the row, and true to show the row.
+     * if the filter parameter is omitted, all values will be shown.
+     *
+     */
+    FilterTable(reference: RangeReference, column?: number, filter?: TableFilterFunction): void;
+
+    /**
+     * sort 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.
      */
     SortTable(reference: RangeReference, options?: Partial<TableSortOptions>): void;
 
@@ -896,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
@@ -914,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 {
 
     /**
@@ -930,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
@@ -1133,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';
 }