@trebco/treb 25.2.0 → 25.4.2

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

@@ -1,25 +1,26 @@
-/*
- * 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
- * 
- */
-
-import { Rectangle, ICellAddress, AnnotationLayout } from 'treb-base-types';
+/*
+ * 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
+ * 
+ */
+
+import type { ICellAddress, AnnotationLayout } from 'treb-base-types';
+import { Rectangle } from 'treb-base-types';
 
 /**
  * new annotation class. annotations are arbitrary content
@@ -78,8 +79,18 @@ export interface ViewData {
 
 }
 
+/**
+ * why is this a class? it doesn't do anything.
+ * FIXME: -> interface
+ */
 export class Annotation {
 
+  /** 
+   * the key field is used to identify and coordinate annotations when we 
+   * have freeze panes. when an annotation crosses a freeze pane, we need
+   * two copies of the rendered node so that we can scroll. we use the key
+   * to match the frozen/unfrozen instances.
+   */
   public get key(): number { return this.key_; }
 
   /** coordinates, in sheet space */
@@ -105,15 +116,6 @@ export class Annotation {
   /** also opaque data, but not serialized. */
   public temp: any = {};
 
-  /* * flag indicating we have inflated this. not serialized */
-  // public inflated = false;
-
-  /* * if function exists, will be called when the annotation is resized */
-  // public resize_callback?: () => void;
-
-  /* * if function exists, will be called when the annotation needs to update */
-  // public update_callback?: () => void;
-
   /** annotation can be resized. this is advisory, for UI */
   public resizable = true;
 
@@ -132,12 +134,6 @@ export class Annotation {
   /** resize when resizing/inserting rows/columns */
   public resize_with_cells = true;
 
-  /* * layout node, obviously not serialized */
-  // public node?: HTMLDivElement;
-
-  /* * content node */
-  // public content_node?: HTMLDivElement;
-
   public view: ViewData[] = [];
 
   /**

package/treb-grid/src/types/data_model.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
+ * 
+ */
+
 import type { Sheet } from './sheet';
 import type { IArea, ICellAddress, Table } from 'treb-base-types';
 import type { SerializedSheet } from './sheet_types';
@@ -26,12 +26,20 @@ import { NamedRangeCollection } from './named_range';
 import type { ExpressionUnit, UnitAddress, UnitStructuredReference, UnitRange } from 'treb-parser';
 import { Style } from 'treb-base-types';
 
-export interface MacroFunction {
+export interface SerializedMacroFunction {
   name: string;
   function_def: string;
   argument_names?: string[];
   // argument_default_values?: any[]; // <- new
   description?: string;
+}
+
+/**
+ * we define this as extending the serialized version, rather
+ * than taking out the parameter, so we can make that def public
+ * in the API types.
+ */
+export interface MacroFunction extends SerializedMacroFunction {
   expression?: ExpressionUnit;
 }