@trebco/treb 27.2.1 → 27.5.3

package/dist/treb.d.ts

@@ -1,4 +1,4 @@
-/*! API v27.2. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
+/*! API v27.5. Copyright 2018-2023 trebco, llc. All rights reserved. LGPL: https://treb.app/license */
 
 /**
  * add our tag to the map
@@ -306,6 +306,18 @@ export declare class EmbeddedSpreadsheet {
      */
     get dirty(): boolean;
 
+    /**
+     * returns the names of all sheets in the current document
+     */
+    get sheet_names(): string[];
+
+    /**
+     * set or remove an external editor. external editor is an interface used
+     * to support outside tooling by highlighting a list of arguments and
+     * responding to selection.
+     */
+    ExternalEditor(editor?: Partial<ExternalEditorType>): void;
+
     /**
      * Use this function to batch multiple document changes. Essentially the
      * grid stops broadcasting events for the duration of the function call,
@@ -741,6 +753,16 @@ export declare class EmbeddedSpreadsheet {
      */
     Resolve(reference: string): ICellAddress | IArea | undefined;
 
+    /**
+     * Convert an address/range object to a string. this is a convenience
+     * function for composing formulas.
+     *
+     * @param ref sheet reference as a string or structured object
+     * @param [qualified=true] include sheet names
+     * @param [named=true] resolve to named ranges, where applicable
+     */
+    Unresolve(ref: RangeReference, qualified?: boolean, named?: boolean): string;
+
     /**
      * Evaluate an arbitrary expression in the spreadsheet. You should generally
      * use sheet names when referring to cells, to avoid ambiguity. Otherwise
@@ -844,11 +866,12 @@ export declare class EmbeddedSpreadsheet {
 
     /**
      * Select a range. This function will change sheets if your reference
-     * refers to a different sheet.
+     * refers to a different sheet. if the argument is undefined or falsy
+     * it will remove the selection (set to no selection).
      *
      * @public
      */
-    Select(range: RangeReference): void;
+    Select(range?: RangeReference): void;
 
     /**
      *
@@ -1032,6 +1055,28 @@ export interface SetRangeOptions {
      */
     r1c1?: boolean;
 }
+export interface ExternalEditorType {
+
+    /**
+     * list of dependencies to highlight. we support undefined entries in
+     * this list so you can use the result of `EmbeddedSpreadsheet.Resolve`,
+     * which may return undefined.
+     */
+    dependencies: DependencyList;
+
+    /**
+     * this callback will be called when the selection changes in the
+     * spreadsheet and this external editor is active. return an updated
+     * list of dependencies to highlight.
+     *
+     * NOTE: this is currently synchronous, but don't rely on that. it
+     * might switch to async in the future depending on how it works in
+     * practice.
+     */
+    update: ExternalEditorCallback;
+}
+export type DependencyList = Array<IArea | ICellAddress | undefined>;
+export type ExternalEditorCallback = (selection?: string) => DependencyList | undefined;
 
 /**
  * Structure represents a 2d range of cells.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trebco/treb",
-  "version": "27.2.1",
+  "version": "27.5.3",
   "license": "LGPL-3.0-or-later",
   "homepage": "https://treb.app",
   "repository": {

package/treb-base-types/src/rectangle.ts

@@ -1,24 +1,24 @@
-/*
- * This file is part of TREB.
- *
- * TREB is free software: you can redistribute it and/or modify it under the 
- * terms of the GNU General Public License as published by the Free Software 
- * Foundation, either version 3 of the License, or (at your option) any 
- * later version.
- *
- * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
- * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
- * details.
- *
- * You should have received a copy of the GNU General Public License along 
- * with TREB. If not, see <https://www.gnu.org/licenses/>. 
- *
- * Copyright 2022-2023 trebco, llc. 
- * info@treb.app
- * 
- */
-
+/*
+ * This file is part of TREB.
+ *
+ * TREB is free software: you can redistribute it and/or modify it under the 
+ * terms of the GNU General Public License as published by the Free Software 
+ * Foundation, either version 3 of the License, or (at your option) any 
+ * later version.
+ *
+ * TREB is distributed in the hope that it will be useful, but WITHOUT ANY 
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with TREB. If not, see <https://www.gnu.org/licenses/>. 
+ *
+ * Copyright 2022-2023 trebco, llc. 
+ * info@treb.app
+ * 
+ */
+
 /** structure represents rectangle coordinates */
 export interface IRectangle {
   top: number;
@@ -81,6 +81,10 @@ export class Rectangle implements IRectangle {
     );
   }
 
+  /*
+   * removing this method as part of cleaning up bitwise flags.
+   * if you need this method, rewrite it to use explicit flags.
+   *
   public CheckEdges(x: number, y: number, border = 16): number{
 
     let edge = 0;
@@ -99,6 +103,7 @@ export class Rectangle implements IRectangle {
 
     return edge;
   }
+  */
 
   /**
    * check if rectangle contains the given coordinates, optionally with

package/treb-embed/src/embedded-spreadsheet.ts

@@ -31,6 +31,7 @@ import type {
   GridSelection, CellEvent, FunctionDescriptor, 
   AnnotationViewData,
   AnnotationType, 
+  ExternalEditorType,
 } from 'treb-grid';
 
 import {
@@ -478,6 +479,13 @@ export class EmbeddedSpreadsheet {
     return this.file_version !== this.last_save_version;
   }
 
+  /**
+   * returns the names of all sheets in the current document
+   */
+  public get sheet_names() {
+    return this.model.sheets.list.map(sheet => sheet.name);
+  }
+
   /**
    * constructor takes spreadsheet options. type should be implicit, either
    * the default (here) or a subclass
@@ -1164,6 +1172,15 @@ export class EmbeddedSpreadsheet {
     }
   }
 
+  /**
+   * set or remove an external editor. external editor is an interface used
+   * to support outside tooling by highlighting a list of arguments and 
+   * responding to selection.
+   */
+  public ExternalEditor(editor?: Partial<ExternalEditorType>) {
+    this.grid.ExternalEditor(editor);
+  }
+
   /**
    * this is not very efficient atm. we create another whole instance of this
    * class, do a lot of unecssary painting and layout. it works but it could
@@ -3397,6 +3414,55 @@ export class EmbeddedSpreadsheet {
 
   }
 
+  /**
+   * Convert an address/range object to a string. this is a convenience
+   * function for composing formulas.
+   * 
+   * @param ref sheet reference as a string or structured object
+   * @param [qualified=true] include sheet names
+   * @param [named=true] resolve to named ranges, where applicable
+   */
+  public Unresolve(ref: RangeReference, qualified = true, named = true): string {
+
+    if (typeof ref === 'string') {
+      const resolved = this.Resolve(ref);
+      if (!resolved) { 
+        throw new Error('invalid reference'); 
+      }
+      ref = resolved;
+    }
+
+    let range = '';
+    const area = IsCellAddress(ref) ? new Area(ref) : new Area(ref.start, ref.end);
+
+    if (named) {
+      const named_range = this.model.named_ranges.MatchSelection(area);
+      if (named_range) {
+        return named_range;
+      }
+    }
+
+    if (area.count > 1) {
+      range = Area.CellAddressToLabel(area.start) + ':' + Area.CellAddressToLabel(area.end);
+    }
+    else {
+      range = Area.CellAddressToLabel(area.start);
+    }
+
+    if (!qualified) {
+      return range;
+    }
+
+    // is there a function to resolve sheet? actually, don't we know that
+    // the active selection must be on the active sheet? (...)
+
+    const sheet_id = area.start.sheet_id || this.grid.active_sheet.id;
+    const sheet_name = this.ResolveSheetName(sheet_id, true);
+
+    return sheet_name ? sheet_name + '!' + range : range;
+    
+  }
+  
   /**
    * Evaluate an arbitrary expression in the spreadsheet. You should generally
    * use sheet names when referring to cells, to avoid ambiguity. Otherwise
@@ -3708,18 +3774,24 @@ export class EmbeddedSpreadsheet {
 
   /**
    * Select a range. This function will change sheets if your reference
-   * refers to a different sheet.
+   * refers to a different sheet. if the argument is undefined or falsy
+   * it will remove the selection (set to no selection).
    * 
    * @public
    */
-  public Select(range: RangeReference): void {
+  public Select(range?: RangeReference): void {
+
+    let resolved: Area|undefined = undefined; 
+
+    if (!!range) {
+      resolved = this.calculator.ResolveArea(range, this.grid.active_sheet);
+      if (resolved.start.sheet_id) {
+        if (resolved.start.sheet_id !== this.grid.active_sheet.id) {
+          this.grid.ActivateSheetID(resolved.start.sheet_id);
+        }
+      }    
+    }
 
-    const resolved = this.calculator.ResolveArea(range, this.grid.active_sheet);
-    if (resolved.start.sheet_id) {
-      if (resolved.start.sheet_id !== this.grid.active_sheet.id) {
-        this.grid.ActivateSheetID(resolved.start.sheet_id);
-      }
-    }    
     this.grid.SelectRange(resolved);
 
   }
@@ -3898,42 +3970,6 @@ export class EmbeddedSpreadsheet {
 
   }
 
-  /**
-   * 
-   */
-  protected Unresolve(ref: ICellAddress|IArea, qualified = true, named = true): string {
-    
-    let range = '';
-    const area = IsCellAddress(ref) ? new Area(ref) : new Area(ref.start, ref.end);
-
-    if (named) {
-      const named_range = this.model.named_ranges.MatchSelection(area);
-      if (named_range) {
-        return named_range;
-      }
-    }
-
-    if (area.count > 1) {
-      range = Area.CellAddressToLabel(area.start) + ':' + Area.CellAddressToLabel(area.end);
-    }
-    else {
-      range = Area.CellAddressToLabel(area.start);
-    }
-
-    if (!qualified) {
-      return range;
-    }
-
-    // is there a function to resolve sheet? actually, don't we know that
-    // the active selection must be on the active sheet? (...)
-
-    const sheet_id = area.start.sheet_id || this.grid.active_sheet.id;
-    const sheet_name = this.ResolveSheetName(sheet_id, true);
-
-    return sheet_name ? sheet_name + '!' + range : range;
-    
-  }
-
   /**
    * replacement for (the great) FileSaver lib. we can now rely on all
    * browsers to handle this properly (fingers crossed).

package/treb-format/src/value_parser.ts

@@ -35,7 +35,7 @@ import { UnlotusDate } from './format';
 
 // tslint:disable:no-bitwise
 
-/** hints is a bitfield */
+/* * hints is a bitfield * /
 export enum Hints {
   None =        0x00,
   Nan =         0x01,
@@ -47,6 +47,18 @@ export enum Hints {
   Date =        0x40,
   Time =        0x80,
 }
+*/
+
+export interface Hints {
+  Nan?: boolean;
+  Exponential?: boolean;
+  Percent?: boolean;
+  Currency?: boolean;
+  Grouping?: boolean;
+  Parens?: boolean;
+  Date?: boolean;
+  Time?: boolean;
+}
 
 /**
  * parse result now uses base valuetype
@@ -222,7 +234,7 @@ class ValueParserType {
    */
   public TryParse(text = ''): ParseResult {
 
-    let hints: Hints = Hints.None;
+    let hints: Hints = {}; // Hints.None;
 
     // starts with SINGLE quote mark. express string.
     if (text[0] === '\'') return { value: text, type: ValueType.string };
@@ -233,7 +245,11 @@ class ValueParserType {
     // we test if the conversion returns NaN, which usually means
     // it's not a number -- unless the string is actually NaN, which
     // is something we want to preserve.
-    if ( text === 'NaN' ) return { value: NaN, type: ValueType.number, hints: Hints.Nan };
+    if ( text === 'NaN' ) return { 
+      value: NaN, 
+      type: ValueType.number, 
+      hints: { Nan: true },
+    };
 
     let x = text.trim();
     // x = x.replace(/^[\$£€]/, '').trim();
@@ -241,25 +257,29 @@ class ValueParserType {
     const currency = x.match(/^[$](.*?)$/);
     if (currency) {
       x = currency[1];
-      hints |= Hints.Currency;
+      // hints |= Hints.Currency;
+      hints.Currency = true;
     }
 
     const parens = x.match(/^\((.*?)\)$/);
     if (parens) {
       x = parens[1];
-      hints |= Hints.Parens;
+      // hints |= Hints.Parens;
+      hints.Parens = true;
     }
 
     const pct = x.match(/^(.*?)%\s*$/);
     if (pct) {
       x = pct[1];
-      hints |= Hints.Percent;
+      // hints |= Hints.Percent;
+      hints.Percent = true;
     }
 
     if (Localization.decimal_separator === '.'){
       if (/,/.test(x)) {
         x = x.replace(/,/g, '');
-        hints |= Hints.Grouping;
+        // hints |= Hints.Grouping;
+        hints.Grouping = true;
       }
     }
     else {
@@ -295,10 +315,10 @@ class ValueParserType {
         const year = check.getUTCFullYear();
 
         if (year >= (this_year - 200) && year <= (this_year + 200)) {
-          hints = Hints.Date;
+          hints = { Date: true };
 
           if (check.getHours() || check.getMinutes() || check.getSeconds()) {
-            hints |= Hints.Time;
+            hints.Time = true;
           }
 
           return {
@@ -328,7 +348,7 @@ class ValueParserType {
       
     }
 
-    if (/e/.test(text)) hints |= Hints.Exponential;
+    if (/e/.test(text)) hints.Exponential = true;
     return { value: num, type: ValueType.number, hints };
 
   }

package/treb-grid/package.json

@@ -1,5 +1,5 @@
 {
   "name": "treb-grid",
-  "version": "16.0.2",
+  "version": "16.1.0",
   "main": "src/index.ts"
 }

package/treb-grid/src/index.ts

@@ -38,4 +38,5 @@ export type { SerializeOptions } from './types/serialize_options';
 export type { FunctionDescriptor, ArgumentDescriptor } from './editors/autocomplete_matcher';
 export { UA } from './util/ua';
 export type { SetRangeOptions } from './types/set_range_options';
-export type { AnnotationData, AnnotationType } from './types/annotation';
+export type { AnnotationData, AnnotationType } from './types/annotation';
+export type { ExternalEditorType, DependencyList, ExternalEditorCallback } from './types/external_editor';

package/treb-grid/src/render/tile_renderer.ts

@@ -394,6 +394,9 @@ export class TileRenderer {
   public RenderColumnLabels(context: CanvasRenderingContext2D, column: number, end: number) {
 
     const header_y = this.layout.header_offset.y;
+    if (header_y <= 1) {
+      return;
+    }
 
     context.fillStyle = ThemeColor2(this.theme, this.theme.headers?.text, 0);
 
@@ -418,7 +421,10 @@ export class TileRenderer {
   public RenderRowLabels(context: CanvasRenderingContext2D, row: number, end: number, block: number) {
 
     const header_x = this.layout.header_offset.x;
-
+    if (header_x <= 1) {
+      return;
+    }
+    
     context.fillStyle = ThemeColor2(this.theme, this.theme.headers?.text, 0);
     
     context.beginPath();

package/treb-grid/src/types/external_editor.ts

@@ -0,0 +1,27 @@
+
+import type { IArea, ICellAddress } from "treb-base-types";
+
+export type DependencyList = Array<IArea|ICellAddress|undefined>;
+export type ExternalEditorCallback = (selection?: string) => DependencyList|undefined;
+
+export interface ExternalEditorType {
+
+  /**
+   * list of dependencies to highlight. we support undefined entries in
+   * this list so you can use the result of `EmbeddedSpreadsheet.Resolve`,
+   * which may return undefined.
+   */
+  dependencies: DependencyList;
+
+  /**
+   * this callback will be called when the selection changes in the 
+   * spreadsheet and this external editor is active. return an updated
+   * list of dependencies to highlight. 
+   * 
+   * NOTE: this is currently synchronous, but don't rely on that. it
+   * might switch to async in the future depending on how it works in 
+   * practice.
+   */
+  update: ExternalEditorCallback;
+
+}