@sheetxl/sdk 0.7.5 → 0.7.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/LICENSE.md +1 -1
  2. package/browser/cjs/{cYybyubtWV2zdUHx.cjs → 6YiDKvszb4QTKhmb.cjs} +1 -1
  3. package/browser/cjs/{1S0sMZK1s3N0t33u.cjs → B-6AVAWj0wJFR6dO.cjs} +1 -1
  4. package/browser/cjs/{DlV7J9o9tqVflPjn.cjs → B4VVw60UQ3vfbmle.cjs} +3 -3
  5. package/browser/cjs/{DFFp9xTUre2rVHh7.cjs → B87MiIGIWM1CB19b.cjs} +1 -1
  6. package/browser/cjs/{BtVqShTZ5IU3zfuI.cjs → BCpzIReLJoNRLVU1.cjs} +1 -1
  7. package/browser/cjs/{DL-5YQONnbSEBBU3.cjs → BDHMsNmKJeWqQ_Ah.cjs} +1 -1
  8. package/browser/cjs/{ByE2d5HXZEmqw0TU.cjs → BShLA4Kkh0AOYVTh.cjs} +1 -1
  9. package/browser/cjs/{CRqbnBjSKaJZ62A6.cjs → BiPuVsv5UeujokJw.cjs} +1 -1
  10. package/browser/cjs/{BGi5LnIyDdqMcLpx.cjs → Bov0O9MprKKSLEUN.cjs} +1 -1
  11. package/browser/cjs/{-uqksHAnL5nEGWzv.cjs → C0Uiuy-T67-6jfdk.cjs} +1 -1
  12. package/browser/cjs/{DS9Fw3nau1wrssIo.cjs → C2fwewNOX7IjJnUs.cjs} +1 -1
  13. package/browser/cjs/{D5Wtjsf65Eg-1sv6.cjs → C4qak2P9P1Py4Tfa.cjs} +1 -1
  14. package/browser/cjs/{DvGMYohGopEJSZau.cjs → CCEkxp3l_zc6hwFz.cjs} +1 -1
  15. package/browser/cjs/{Cj__xB2cDhMEfpuf.cjs → CG-8zldtiozHdU6d.cjs} +1 -1
  16. package/browser/cjs/{BYGX2tERLck9VP-I.cjs → CRkHJ_23CST6gsS4.cjs} +1 -1
  17. package/browser/cjs/{DHOe_V_hKlMrqhPa.cjs → Ce8ERxKLMH8eLe_5.cjs} +1 -1
  18. package/browser/cjs/{DL9orrPq0c2V3f4p.cjs → ChJbzGbiVBCnGaGa.cjs} +1 -1
  19. package/browser/cjs/{D9qztL5pQdlbhPYb.cjs → ChUr9QKfIL7vF_B0.cjs} +1 -1
  20. package/browser/cjs/{CW9m55xnr4ii2KGx.cjs → D95myDh-N6M7a6EC.cjs} +2 -2
  21. package/browser/cjs/{4EiWm2KDG50E5y_6.cjs → D9rERLaYDKUc9qch.cjs} +1 -1
  22. package/browser/cjs/{BpHhKYxVUE265JBy.cjs → DDa2Qn9hJAPjnhCH.cjs} +1 -1
  23. package/browser/cjs/{T7IxGWAsvLKBsPNY.cjs → DGC6f_6wlFM5VRrr.cjs} +2 -2
  24. package/browser/cjs/DGDPwgpaSETDtxCN.cjs +55 -0
  25. package/browser/cjs/{BbOpR3W-DLNUIz86.cjs → DeEljP-uvzcM34GT.cjs} +1 -1
  26. package/browser/cjs/{sJWTx_katnHrL8aQ.cjs → DfUeqUiL4bBlAhdF.cjs} +1 -1
  27. package/browser/cjs/index.cjs +2 -2
  28. package/browser/cjs/{ySPPgh7lYvx5M3bd.cjs → kqUd8g5hhQmjxw-7.cjs} +1 -1
  29. package/browser/cjs/{uu2pXKuh-tTKPFCA.cjs → slNr9hOAgryqEMyq.cjs} +1 -1
  30. package/{node/esm/BbwH3LDSvzso_F-X.mjs → browser/esm/3taHjNdnWalGdFoN.mjs} +1 -1
  31. package/browser/esm/{Dmp8O6bOZORqDaA9.mjs → 7fdgLbvHzfxbpwJ1.mjs} +1 -1
  32. package/browser/esm/{B4hxTanwXZGIvFU3.mjs → BDBDC-tU9iYsgoqc.mjs} +1 -1
  33. package/browser/esm/{XNXF_ScnDx7iPyEX.mjs → BHKlRr_d3a-Ya_Su.mjs} +1 -1
  34. package/browser/esm/{B9G7xUIJQWP3L211.mjs → BXqwtRYeKXwaRkV_.mjs} +1 -1
  35. package/browser/esm/{Bledbteg6YDr9AGf.mjs → BsoDrSnLS8G3AJ3u.mjs} +1 -1
  36. package/{node/esm/Cs8IoYlfFo1u6Mi6.mjs → browser/esm/C04EaRL-IaVpZrV6.mjs} +1 -1
  37. package/browser/esm/{BHKbsa_gG3PMfvGW.mjs → C11CU2VQMPa4WzZU.mjs} +1 -1
  38. package/browser/esm/{-1oXsCJphcxX9cfW.mjs → CARs01wGHA9RsDGg.mjs} +1 -1
  39. package/browser/esm/{Ch8xiyO9VhbEpQCE.mjs → CH5s8whBuz7_QNkE.mjs} +1 -1
  40. package/browser/esm/{F3Xo1gW8r-5VGO5E.mjs → CKgk76So3qcfcbsH.mjs} +1 -1
  41. package/{node/esm/CG-R9aP7EhUTt5m3.mjs → browser/esm/CmGeq0aRlEliSS5J.mjs} +1 -1
  42. package/browser/esm/{BRwHF3JsVMB8gXLb.mjs → D11ZnQb02ftmGbHB.mjs} +1 -1
  43. package/browser/esm/{B7Ku6lQf0CRbqDja.mjs → D2IBRYlusWRArNGL.mjs} +1 -1
  44. package/browser/esm/{DdE7db1pm5fSIFY0.mjs → D9xgLV4uaDpD4saH.mjs} +1 -1
  45. package/{node/esm/C-pmirkhKx2LZTbS.mjs → browser/esm/DCc4PEcMjmtt0eZS.mjs} +1 -1
  46. package/browser/esm/{Dfzyu9t6YtDdEBq6.mjs → DFDwDLLSOBJY-mTG.mjs} +2 -2
  47. package/{node/esm/CfphR9xnSPYcNB_3.mjs → browser/esm/DZBoAWNa-PcXWjXT.mjs} +1 -1
  48. package/browser/esm/{CwlFwvi_wo1zs0D9.mjs → DhD71gpoqktUC4-1.mjs} +1 -1
  49. package/browser/esm/{BMB-Kb_DHFCZVgHa.mjs → DpzqASL8k7y8SrVp.mjs} +1 -1
  50. package/browser/esm/{DFlqgvalm7SiNKkG.mjs → K9D_aiqdvcMIMQUn.mjs} +2 -2
  51. package/browser/esm/{COR33mX_k3BQIpHk.mjs → MhkAJnoTgT1NERew.mjs} +3 -3
  52. package/browser/esm/{DGBej8oNEHx3Zoi5.mjs → T6K4zXnAClxK-6of.mjs} +1 -1
  53. package/browser/esm/{CQUfFgOC_wQL3Dy5.mjs → Vyu4kkPirTv77rqZ.mjs} +1 -1
  54. package/browser/esm/{DmoSyqtYZz8_paWe.mjs → X0a-IoCuOBC1WZwO.mjs} +1 -1
  55. package/{node/esm/BDu0aHArby8vg7U7.mjs → browser/esm/gzqYXI3Fvz0T6OJ7.mjs} +1 -1
  56. package/browser/esm/index.mjs +2 -2
  57. package/browser/esm/{tS6XyWF6FOqdHUMq.mjs → lHzCw1GM3TwlAcTJ.mjs} +6717 -6667
  58. package/licenses/dependencies.txt +1 -1
  59. package/{browser/esm/BbwH3LDSvzso_F-X.mjs → node/esm/3taHjNdnWalGdFoN.mjs} +1 -1
  60. package/node/esm/{B4hxTanwXZGIvFU3.mjs → BDBDC-tU9iYsgoqc.mjs} +1 -1
  61. package/node/esm/{D_a5ynfcojSuQk6a.mjs → BDUMJbvVahP0qvqH.mjs} +1 -1
  62. package/node/esm/{Bxod6mZNp8yk4B2q.mjs → BK9r574tKB8mQ1x1.mjs} +1 -1
  63. package/node/esm/{C4hi8VdjdALkvIpc.mjs → BLkrfw6JvbKEo67o.mjs} +1 -1
  64. package/node/esm/{B9G7xUIJQWP3L211.mjs → BXqwtRYeKXwaRkV_.mjs} +1 -1
  65. package/node/esm/{DGRAWwNBIeDuY9lv.mjs → BjpcNcX4Vhv44YX4.mjs} +1 -1
  66. package/node/esm/{Cnx_k3Wt04uwJo6e.mjs → BkAqe5aH4ZS5iG3o.mjs} +1 -1
  67. package/{browser/esm/Cs8IoYlfFo1u6Mi6.mjs → node/esm/C04EaRL-IaVpZrV6.mjs} +1 -1
  68. package/node/esm/{F3Xo1gW8r-5VGO5E.mjs → CKgk76So3qcfcbsH.mjs} +1 -1
  69. package/{browser/esm/CG-R9aP7EhUTt5m3.mjs → node/esm/CmGeq0aRlEliSS5J.mjs} +1 -1
  70. package/node/esm/{BRwHF3JsVMB8gXLb.mjs → D11ZnQb02ftmGbHB.mjs} +1 -1
  71. package/node/esm/{B7Ku6lQf0CRbqDja.mjs → D2IBRYlusWRArNGL.mjs} +1 -1
  72. package/node/esm/{BcpKCEahFJP3CQdz.mjs → D2KbzMOkas3hur0w.mjs} +1 -1
  73. package/node/esm/{DdE7db1pm5fSIFY0.mjs → D9xgLV4uaDpD4saH.mjs} +1 -1
  74. package/{browser/esm/C-pmirkhKx2LZTbS.mjs → node/esm/DCc4PEcMjmtt0eZS.mjs} +1 -1
  75. package/node/esm/{CVSNo61E9p55B3H7.mjs → DNj6ugQcYOjrfvJw.mjs} +1 -1
  76. package/node/esm/{BW8AXL-kVt_jrvZ7.mjs → DTw4BKoGHXdSDlEk.mjs} +1 -1
  77. package/node/esm/{purzcgsLDsGsJTZU.mjs → DWOm2-5P3DAsRN9c.mjs} +2 -2
  78. package/{browser/esm/CfphR9xnSPYcNB_3.mjs → node/esm/DZBoAWNa-PcXWjXT.mjs} +1 -1
  79. package/node/esm/{CwlFwvi_wo1zs0D9.mjs → DhD71gpoqktUC4-1.mjs} +1 -1
  80. package/node/esm/{BMB-Kb_DHFCZVgHa.mjs → DpzqASL8k7y8SrVp.mjs} +1 -1
  81. package/node/esm/{DGBej8oNEHx3Zoi5.mjs → T6K4zXnAClxK-6of.mjs} +1 -1
  82. package/node/esm/{DmoSyqtYZz8_paWe.mjs → X0a-IoCuOBC1WZwO.mjs} +1 -1
  83. package/{browser/esm/BDu0aHArby8vg7U7.mjs → node/esm/gzqYXI3Fvz0T6OJ7.mjs} +1 -1
  84. package/node/esm/index.mjs +3216 -3188
  85. package/package.json +7 -7
  86. package/types/index.d.ts +118 -53
  87. package/types/scripting.d.ts +195 -116
  88. package/browser/cjs/ByUEJSU9dSKLxphy.cjs +0 -54
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sheetxl/sdk",
3
3
  "description": "SDK - A high-performance, embeddable spreadsheet engine.",
4
- "version": "0.7.5",
4
+ "version": "0.7.7",
5
5
  "license": "SEE LICENSE IN <LICENSE>",
6
6
  "type": "module",
7
7
  "exports": {
@@ -43,20 +43,20 @@
43
43
  "automation"
44
44
  ],
45
45
  "dependencies": {
46
- "@sheetxl/primitives": "^0.7.5",
47
- "@sheetxl/scripting": "^0.7.5",
48
- "@sheetxl/utils": "^0.7.5",
46
+ "@sheetxl/primitives": "^0.7.7",
47
+ "@sheetxl/scripting": "^0.7.7",
48
+ "@sheetxl/utils": "^0.7.7",
49
49
  "bahttext": "^2.3.0",
50
50
  "bessel": "^1.0.2",
51
- "chalk": "^5.5.0",
51
+ "chalk": "^5.6.2",
52
52
  "chevrotain": "^11.0.3",
53
- "configstore": "^7.0.0",
53
+ "configstore": "^7.1.0",
54
54
  "css-font-parser": "^2.0.0",
55
55
  "csstype": "^3.1.3",
56
56
  "fontkit": "^2.0.4",
57
57
  "jstat": "^1.9.6",
58
58
  "linebreak": "^1.1.0",
59
- "lru-cache": "^11.0.2",
59
+ "lru-cache": "^11.2.2",
60
60
  "papaparse": "^5.5.3"
61
61
  },
62
62
  "devDependencies": {
package/types/index.d.ts CHANGED
@@ -5,7 +5,6 @@ import { CompiledModule } from '@sheetxl/scripting';
5
5
  import { CompileOptions } from '@sheetxl/scripting';
6
6
  import { CompileResults } from '@sheetxl/scripting';
7
7
  import { CoordUtils } from '@sheetxl/utils';
8
- import { Dimensions } from '@sheetxl/utils';
9
8
  import { Direction } from '@sheetxl/utils';
10
9
  import { EditMode } from '@sheetxl/utils';
11
10
  import { FetchArgs } from '@sheetxl/utils';
@@ -29,6 +28,7 @@ import { RunCoords } from '@sheetxl/utils';
29
28
  import { Scalar } from '@sheetxl/primitives';
30
29
  import { ScalarType } from '@sheetxl/primitives';
31
30
  import { SelectionCoords } from '@sheetxl/utils';
31
+ import { Size } from '@sheetxl/utils';
32
32
  import { TextAlign } from 'csstype';
33
33
  import { TopLeft } from '@sheetxl/utils';
34
34
  import { UndoManager } from '@sheetxl/utils';
@@ -805,7 +805,7 @@ declare const clampString: (str: string, maxLength?: number) => string;
805
805
  * Takes an an inner un-rotated dimension and an outer un-rotated dimension and then will return
806
806
  * an un-rotated rectangle that if rotated will fit inside the outer rectangle.
807
807
  */
808
- declare const clipToOuterRect: (dimInner: Dimensions, dimOuter: Dimensions, rotation?: number) => Dimensions;
808
+ declare const clipToOuterRect: (dimInner: Size, dimOuter: Size, rotation?: number) => Size;
809
809
 
810
810
  /**
811
811
  * Capabilities for working with {@link IColor | colors}.
@@ -1321,7 +1321,7 @@ declare const getFileNameExtension: (path: string) => string;
1321
1321
  declare function getFontList(): readonly FontHandle[];
1322
1322
 
1323
1323
  declare interface GetRangeEntriesOptions<T = any, E = any> {
1324
- excludeHidden?: boolean | IRange.Orientation;
1324
+ ignoreHidden?: boolean | IRange.Orientation;
1325
1325
  fullyContained?: boolean;
1326
1326
  onEntry?: (value: E, entry: ISpatialMap.Entry<T>) => T | void;
1327
1327
  noCache?: boolean;
@@ -3302,12 +3302,10 @@ export declare interface ICell {
3302
3302
  /**
3303
3303
  * Returns the cell's value as a formatted string, applying any number formatting.
3304
3304
  *
3305
- * @param numFmt A custom number format to apply (optional).
3306
- *
3307
3305
  * @see
3308
3306
  * {@link toTextUnformatted}
3309
3307
  */
3310
- toText(numFmt?: string): string;
3308
+ toText(): string;
3311
3309
  /**
3312
3310
  * Returns the cell's value as an unformatted string.
3313
3311
  *
@@ -3354,7 +3352,7 @@ export declare interface ICell {
3354
3352
  * Returns `null` if this cell should be ignored for sizing purposes.
3355
3353
  * Either dimension can also be `null`, indicating that the specific direction should not be used.
3356
3354
  */
3357
- getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Dimensions>> | null;
3355
+ getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
3358
3356
  /**
3359
3357
  * Returns protection information.
3360
3358
  */
@@ -3369,7 +3367,7 @@ export declare interface ICell {
3369
3367
  /**
3370
3368
  * Returns the span dimensions for merged cells.
3371
3369
  */
3372
- getSpans(): Readonly<Dimensions>;
3370
+ getSpans(): Readonly<Size>;
3373
3371
  /**
3374
3372
  * Returns `true` if the cell is the top-left cell of a merged region, or if it is not part of a merged region.
3375
3373
  */
@@ -4134,7 +4132,7 @@ export declare namespace ICellHeaderRange {
4134
4132
  * optionally a header orientation for skipping case be passed in.
4135
4133
  * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
4136
4134
  */
4137
- excludeHidden?: boolean;
4135
+ ignoreHidden?: boolean;
4138
4136
  }
4139
4137
  /**
4140
4138
  * Context for Iterators to provide access to the `IRange.CellCoords`, the `ICellHeader`, and additional operators.
@@ -4357,7 +4355,7 @@ export declare interface ICellRange {
4357
4355
  * Returns the value for the top left `Scalar`.
4358
4356
  *
4359
4357
  * @remarks
4360
- * The `excludeHidden` option is ignored.
4358
+ * The `ignoreHidden` option is ignored.
4361
4359
  *
4362
4360
  * @see
4363
4361
  * {@link ICellRange.getValues}
@@ -4567,6 +4565,10 @@ export declare interface ICellRange {
4567
4565
  * * Setting {@link ICellRange.GetValuesOptions.asJSDate} to `true` will add make slower.
4568
4566
  */
4569
4567
  getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
4568
+ /**
4569
+ * Returns the range value as a string.
4570
+ */
4571
+ toText(options?: ICellRange.ToTextOptions): string;
4570
4572
  /**
4571
4573
  * Set the value(s) of one or more cells within a range.
4572
4574
  *
@@ -4583,6 +4585,7 @@ export declare interface ICellRange {
4583
4585
  setValues(values: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
4584
4586
  /**
4585
4587
  * Provides a convenient method for setting values with a range of calls.
4588
+ *
4586
4589
  * @param update {@link ICellRange.Update}
4587
4590
  * @param options {@link ICellRange.UpdateCellsOptions}
4588
4591
  * @returns The current `ICellRange`.
@@ -4694,10 +4697,9 @@ export declare interface ICellRange {
4694
4697
  /**
4695
4698
  * Returns an iterator of ICells that match the results.
4696
4699
  *
4697
- * @param text The text to search for.
4698
- * @param options {@link FindOptions}
4700
+ * @param options The text to search for or {@link FindOptions}
4699
4701
  */
4700
- find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
4702
+ find(options: string | ICellRange.FindOptions): Iterator<ICell>;
4701
4703
  /**
4702
4704
  * Sort the given range.
4703
4705
  *
@@ -4715,28 +4717,28 @@ export declare interface ICellRange {
4715
4717
  * By default the values will direction in whichever direction the selection shape is smaller.
4716
4718
  * For example a selection with a 5 column by 1 row will direction Down (rows).
4717
4719
  * Note - This will error if direction data will fall outsize of the max sheet size.
4718
- * @param orientation The direction in which to shift existing cells.
4720
+ * @param options The orientation or The direction in which to shift existing cells.
4719
4721
  * Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
4720
4722
  * See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
4721
- * @param options {@link ITransaction.OperationOptions}
4723
+ * See {@link ITransaction.OperationOptions}
4722
4724
  * @throws `Error` If the insertion would cause data to exceed the maximum sheet size.
4723
4725
  * @returns Current `ICellRange`.
4724
4726
  */
4725
- insert(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
4727
+ insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
4726
4728
  /**
4727
4729
  * Delete the cells within the range and shifts the remaining cells to fill the gap.
4728
4730
  *
4729
- * @param orientation The direction in which to shift the remaining cells.
4730
- * Defaults to the orientation where the range's dimension is smaller (e.g., shifts left if the range is taller than it is wide).
4731
+ * @param options The orientation or The direction in which to shift existing cells.
4732
+ * Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
4731
4733
  * See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
4732
- * @param options {@link ITransaction.OperationOptions}
4734
+ * See {@link ITransaction.OperationOptions}
4733
4735
  * @returns Current `ICellRange`.
4734
4736
  *
4735
4737
  * @remarks
4736
4738
  * This is different from clearing cells, which removes their content but doesn't affect the
4737
4739
  * overall sheet structure. Deleting cells results in a shift of the remaining data.
4738
4740
  */
4739
- delete(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
4741
+ delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
4740
4742
  /**
4741
4743
  * Returns a snapshot of the current range's data and formatting suitable for copying or archiving.
4742
4744
  *
@@ -4967,6 +4969,13 @@ export declare interface ICellRange {
4967
4969
  * @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
4968
4970
  */
4969
4971
  entries(options?: ICellRange.IteratorOptions): IterableIterator<ICellRange.Entry>;
4972
+ /**
4973
+ * Returns the values within the range, yielding each value.
4974
+ *
4975
+ * @param options Configuration options for the iterator, such as filtering or sorting.
4976
+ * @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
4977
+ */
4978
+ values(options?: ICellRange.IteratorOptions): IterableIterator<Scalar>;
4970
4979
  /**
4971
4980
  * Iterates over the cells within the range, applying the provided callback function to each cell.
4972
4981
  *
@@ -5023,6 +5032,28 @@ export declare namespace ICellRange {
5023
5032
  */
5024
5033
  export interface GetRangeOptions {
5025
5034
  }
5035
+ /**
5036
+ * Options for `ICellRange.delete`.
5037
+ */
5038
+ export interface InsertOptions extends ITransaction.OperationOptions {
5039
+ /**
5040
+ * The direction in which to shift existing cells.
5041
+ * Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
5042
+ * See {@link ICellRange.getDefaultShiftOrientation}
5043
+ */
5044
+ orientation?: IRange.Orientation;
5045
+ }
5046
+ /**
5047
+ * Options for `ICellRange.delete`.
5048
+ */
5049
+ export interface DeleteOptions extends ITransaction.OperationOptions {
5050
+ /**
5051
+ * The direction in which to shift existing cells.
5052
+ * Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
5053
+ * See {@link ICellRange.getDefaultShiftOrientation}
5054
+ */
5055
+ orientation?: IRange.Orientation;
5056
+ }
5026
5057
  /**
5027
5058
  * Shorthand for persisting.
5028
5059
  */
@@ -5227,10 +5258,16 @@ export declare namespace ICellRange {
5227
5258
  * - Optionally, you can specify a `IRange.Orientation` to indicate the header orientation for skipping cases.
5228
5259
  * For example, in sorting, you might want to skip hidden rows but not hidden columns.
5229
5260
  */
5230
- excludeHidden?: boolean | IRange.Orientation;
5261
+ ignoreHidden?: boolean | IRange.Orientation;
5231
5262
  /** {@inheritDoc ICellRange.IteratorOptions.includeMergeOverflow} */
5232
5263
  includeMergeOverflow?: boolean;
5233
5264
  }
5265
+ /**
5266
+ * Options for {@link ICellRange.toText}.
5267
+ */
5268
+ export interface ToTextOptions extends ICellRange.GetValuesOptions {
5269
+ ignoreFormatting?: boolean;
5270
+ }
5234
5271
  /**
5235
5272
  * Options for {@link ICellRange.autoFit}.
5236
5273
  */
@@ -5482,6 +5519,12 @@ export declare namespace ICellRange {
5482
5519
  * Options for {@link ICellRange.find}.
5483
5520
  */
5484
5521
  export interface FindOptions extends FindCriteria {
5522
+ /**
5523
+ * The text to search for.
5524
+ *
5525
+ * @required
5526
+ */
5527
+ text: string;
5485
5528
  /**
5486
5529
  * Provides custom logic for matching values during the find operation.
5487
5530
  *
@@ -5623,6 +5666,15 @@ export declare namespace ICellRange {
5623
5666
  * Alias type for count results by type.
5624
5667
  */
5625
5668
  export type Counts = Partial<Record<ICell.Content, number>>;
5669
+ export interface ScrollIntoViewOptions extends globalThis.ScrollIntoViewOptions {
5670
+ /**
5671
+ * If provided then will only scroll in the provided orientation.
5672
+ *
5673
+ * @remarks
5674
+ * This is useful for only scrolling vertically or horizontally for insert/deleteCells
5675
+ */
5676
+ orientation?: IRange.Orientation;
5677
+ }
5626
5678
  /**
5627
5679
  * Extends SelectionOptions to include the option to adjust the anchor cell.
5628
5680
  */
@@ -5636,6 +5688,17 @@ export declare namespace ICellRange {
5636
5688
  * If the current anchor is not within the current range this will be forced to `true`.
5637
5689
  */
5638
5690
  anchor?: boolean | Partial<IRange.CellCoords>;
5691
+ /**
5692
+ * If `true` or if a valid `ScrollIntoViewOptions` object is provided,
5693
+ * the selected element will be scrolled into view.
5694
+ *
5695
+ * @remarks
5696
+ * - If a `ScrollIntoViewOptions` object is provided, it will control the exact scrolling behavior.
5697
+ * - If `false` (or omitted), the selected element will not be scrolled into view.
5698
+ *
5699
+ * @defaultValue false
5700
+ */
5701
+ scrollIntoView?: boolean | ICellRange.ScrollIntoViewOptions;
5639
5702
  }
5640
5703
  /**
5641
5704
  * Options for customizing how values are retrieved from a range and returned as a 2D array.
@@ -5669,7 +5732,7 @@ export declare namespace ICellRange {
5669
5732
  * Optionally a header orientation for skipping case be passed in.
5670
5733
  * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
5671
5734
  */
5672
- excludeHidden?: boolean | IRange.Orientation;
5735
+ ignoreHidden?: boolean | IRange.Orientation;
5673
5736
  /**
5674
5737
  * If set to true the only the raw values will be visited.
5675
5738
  *
@@ -5678,7 +5741,7 @@ export declare namespace ICellRange {
5678
5741
  * @remarks
5679
5742
  * This allows for much faster reading when only the value is needed.
5680
5743
  */
5681
- excludeCellDetails?: boolean;
5744
+ ignoreCellDetails?: boolean;
5682
5745
  /**
5683
5746
  * Includes any merge overflow in first element visited.
5684
5747
  *
@@ -5866,7 +5929,7 @@ export declare interface ICellRanges {
5866
5929
  /**
5867
5930
  * {@inheritDoc ICellRange.find}
5868
5931
  */
5869
- find(findText: string, options?: ICellRange.FindOptions): Iterator<ICell>;
5932
+ find(options: string | ICellRange.FindOptions): Iterator<ICell>;
5870
5933
  /**
5871
5934
  * Iterates over the values, yielding each values in the collection.
5872
5935
  *
@@ -5902,7 +5965,7 @@ export declare interface ICellRanges {
5902
5965
  /**
5903
5966
  * {@inheritDoc ICellRange.merge}
5904
5967
  */
5905
- merge(options?: ICellRange.MergeOptions | IRange.Orientations): this;
5968
+ merge(options?: IRange.Orientations | ICellRange.MergeOptions): this;
5906
5969
  /**
5907
5970
  * {@inheritDoc ICellRange.unmerge}
5908
5971
  */
@@ -5910,11 +5973,11 @@ export declare interface ICellRanges {
5910
5973
  /**
5911
5974
  * {@inheritDoc ICellRange.insert}
5912
5975
  */
5913
- insert(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
5976
+ insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
5914
5977
  /**
5915
5978
  * {@inheritDoc ICellRange.delete}
5916
5979
  */
5917
- delete(orientation?: IRange.Orientation, options?: ITransaction.OperationOptions): this;
5980
+ delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
5918
5981
  /**
5919
5982
  * {@inheritDoc ICellRange.insertFrom}
5920
5983
  */
@@ -7901,7 +7964,7 @@ export declare namespace IConditionalFormatCollection {
7901
7964
  *
7902
7965
  * @defaultValue false
7903
7966
  */
7904
- excludeHidden?: boolean;
7967
+ ignoreHidden?: boolean;
7905
7968
  /**
7906
7969
  * Only return items that are completely contained with the search bounds.
7907
7970
  *
@@ -10094,7 +10157,7 @@ export declare namespace IMovableCollection {
10094
10157
  * Indicate if items that are in hidden headers or marked as hidden should be returned.
10095
10158
  * @defaultValue false
10096
10159
  */
10097
- excludeHidden?: boolean;
10160
+ ignoreHidden?: boolean;
10098
10161
  /**
10099
10162
  * The type to search for. If not provided all items will be returned.
10100
10163
  */
@@ -10660,7 +10723,7 @@ export declare namespace IPicture {
10660
10723
  /**
10661
10724
  * The size of the image without any constraints. This info is determined by the file.
10662
10725
  */
10663
- getNaturalDimensions(): Dimensions;
10726
+ getNaturalSize(): Size;
10664
10727
  /**
10665
10728
  * As a url that can be attached to the dom.
10666
10729
  */
@@ -11684,7 +11747,7 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
11684
11747
  * @see
11685
11748
  * {@link ICellRange.find}
11686
11749
  */
11687
- find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
11750
+ find(options: string | ICellRange.FindOptions): Iterator<ICell>;
11688
11751
  /**
11689
11752
  * Enable and return an {@link IAutoFilter}.
11690
11753
  *
@@ -11888,9 +11951,9 @@ export declare interface ISheet extends ITransaction.ITransactional, IListener.I
11888
11951
  /**
11889
11952
  * Returns a JSON representation of the sheet.
11890
11953
  *
11891
- * @param excludeData If `true` only meta data about the sheet will be saved.
11954
+ * @param ignoreData If `true` only meta data about the sheet will be saved.
11892
11955
  */
11893
- toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
11956
+ toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
11894
11957
  /**
11895
11958
  * Free all resources associated with the sheet.
11896
11959
  *
@@ -12079,7 +12142,7 @@ export declare namespace ISheet {
12079
12142
  * @remarks
12080
12143
  * This should only be handled by one consumer.
12081
12144
  */
12082
- onRequestScrollIntoView?(source: ISheet, options: ScrollToOptions): Promise<boolean>;
12145
+ onRequestScrollIntoView?(source: ISheet, options: ISheet.ScrollToOptions): Promise<boolean>;
12083
12146
  /**
12084
12147
  * Request that the sheet become focused.
12085
12148
  * @returns A promise indicating if the focus was honored.
@@ -13206,7 +13269,7 @@ export declare namespace ISort {
13206
13269
  export interface DefaultSortCriteria {
13207
13270
  /**
13208
13271
  * The cords that will be sorted.
13209
- * This may exclude the header.
13272
+ * This may ignore the header.
13210
13273
  */
13211
13274
  coords: IRange.Coords;
13212
13275
  /**
@@ -14139,7 +14202,7 @@ export declare interface IStyle {
14139
14202
  /**
14140
14203
  * Returns the best fit size assuming no content.
14141
14204
  */
14142
- getBestFit(): Partial<Dimensions> | null;
14205
+ getBestFit(): Partial<Size> | null;
14143
14206
  /**
14144
14207
  * Returns insets used for content. This does not taking into account indent because
14145
14208
  * this is alignment and type specific.
@@ -14884,7 +14947,7 @@ export declare interface IStyledFont {
14884
14947
  * Additionally due to the nature of css having different properties for the same logic value
14885
14948
  * (for example color, backgroundColor)
14886
14949
  */
14887
- toCSS(darkMode?: boolean, zoom?: number, excludeNormal?: boolean): Properties;
14950
+ toCSS(darkMode?: boolean, zoom?: number, ignoreNormal?: boolean): Properties;
14888
14951
  /**
14889
14952
  * Serializes to a JSON object.
14890
14953
  */
@@ -15406,7 +15469,7 @@ export declare namespace ITableCollection {
15406
15469
  *
15407
15470
  * @defaultValue false
15408
15471
  */
15409
- excludeHidden?: boolean;
15472
+ ignoreHidden?: boolean;
15410
15473
  /**
15411
15474
  * Only return items that are completely contained with the filter bounds.
15412
15475
  *
@@ -15968,7 +16031,7 @@ export declare interface ITextFrame {
15968
16031
  *
15969
16032
  * @param dimensions will cause the text to wrap. If bounds are not specified or only a dimension then it will not wrap.
15970
16033
  */
15971
- layout(dimensions?: Partial<Dimensions>): ITextFrame;
16034
+ layout(dimensions?: Partial<Size>): ITextFrame;
15972
16035
  /**
15973
16036
  * This is the bound of a textfield include any whitespace
15974
16037
  */
@@ -17062,7 +17125,7 @@ export declare namespace ITypes {
17062
17125
  *
17063
17126
  * @defaultValue false
17064
17127
  */
17065
- scrollIntoView?: globalThis.ScrollIntoViewOptions | boolean;
17128
+ scrollIntoView?: boolean | globalThis.ScrollIntoViewOptions;
17066
17129
  /**
17067
17130
  * If `true`, the selected element will automatically receive focus after being selected.
17068
17131
  *
@@ -17167,8 +17230,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
17167
17230
  /**
17168
17231
  * Search the entire Workbook.
17169
17232
  *
17170
- * @param text The text to search for.
17171
- * @param options {@link ICellRange.FindOptions}
17233
+ * @param options The text to search for or {@link ICellRange.FindOptions}
17172
17234
  *
17173
17235
  * @remarks
17174
17236
  * Searches all sheets.
@@ -17176,7 +17238,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
17176
17238
  * @see
17177
17239
  * {@link ICellRange.find}
17178
17240
  */
17179
- find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
17241
+ find(options: string | ICellRange.FindOptions): Iterator<ICell>;
17180
17242
  /**
17181
17243
  * Replace all items in the iterator
17182
17244
  *
@@ -17207,6 +17269,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
17207
17269
  findValidSheetName(sheetName: string): string;
17208
17270
  /**
17209
17271
  * Indicate if the current character is a valid character for a sheetName.
17272
+ *
17210
17273
  * @param character The string to validate.
17211
17274
  */
17212
17275
  isValidSheetNameCharacter(character: string): boolean;
@@ -17250,6 +17313,7 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
17250
17313
  setTheme(theme: ITheme | null): ITheme;
17251
17314
  /**
17252
17315
  * Is date resolution 1904 instead of 1900 based.
17316
+ *
17253
17317
  * @see
17254
17318
  * {@link https://support.microsoft.com/en-us/office/date-systems-in-excel-e7fe7167-48a9-4b96-bb53-5612a800b487}
17255
17319
  */
@@ -17291,9 +17355,9 @@ export declare interface IWorkbook extends ITransaction.ITransactional, IListene
17291
17355
  /**
17292
17356
  * Serialize the workbook to a JSON.
17293
17357
  *
17294
- * @param excludeData If `true` only meta data about the workbook will be saved.
17358
+ * @param ignoreData If `true` only meta data about the workbook will be saved.
17295
17359
  */
17296
- toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
17360
+ toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
17297
17361
  /**
17298
17362
  * Returns any custom workbook options that are provided in constructor.
17299
17363
  */
@@ -18397,7 +18461,7 @@ declare namespace RangeState {
18397
18461
  interface IteratorOptions extends OverlappingRange.IteratorOptions {
18398
18462
  includeRangeTypes: boolean | SearchTypes;
18399
18463
  bounds?: IRange.Coords;
18400
- excludeHidden?: boolean | IRange.Orientation;
18464
+ ignoreHidden?: boolean | IRange.Orientation;
18401
18465
  includeMergeOverflow?: boolean;
18402
18466
  }
18403
18467
  interface Entry {
@@ -18626,7 +18690,7 @@ export declare class Sheet implements ISheet {
18626
18690
  };
18627
18691
  protected _lastGetRangeRead: Record<string, {
18628
18692
  ranges: readonly IRange.Coords[];
18629
- excludeHidden: boolean | IRange.Orientation;
18693
+ ignoreHidden: boolean | IRange.Orientation;
18630
18694
  results: any[];
18631
18695
  }>;
18632
18696
  protected _lastUsedCoordsRead: {
@@ -18669,7 +18733,7 @@ export declare class Sheet implements ISheet {
18669
18733
  protected _closed: boolean;
18670
18734
  protected _defaultColWidthCache: number;
18671
18735
  protected _defaultRowHeightCache: number;
18672
- protected _defaultFontBoundsCache: Readonly<Dimensions>;
18736
+ protected _defaultFontBoundsCache: Readonly<Size>;
18673
18737
  constructor(options?: ISheet.ConstructorOptions);
18674
18738
  /* Excluded from this release type: _createRange */
18675
18739
  /* Excluded from this release type: _createRanges */
@@ -18753,7 +18817,7 @@ export declare class Sheet implements ISheet {
18753
18817
  /** {@inheritDoc ISheet.getSelectedCell} */
18754
18818
  getSelectedCell(): ICell;
18755
18819
  /** {@inheritDoc ISheet.find} */
18756
- find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
18820
+ find(options?: string | ICellRange.FindOptions): Iterator<ICell>;
18757
18821
  /* Excluded from this release type: _find */
18758
18822
  /** {@inheritDoc ISheet.isDate1904} */
18759
18823
  isDate1904(): boolean;
@@ -18769,6 +18833,7 @@ export declare class Sheet implements ISheet {
18769
18833
  /* Excluded from this release type: _selectSheet */
18770
18834
  /** {@inheritDoc ISheet.scrollTo} */
18771
18835
  scrollTo(coords: Partial<IRange.Coords>, options?: ISheet.ScrollToOptions): Promise<boolean>;
18836
+ /* Excluded from this release type: _resolveSelectOptions */
18772
18837
  /* Excluded from this release type: _commitAndAutoSelect */
18773
18838
  /* Excluded from this release type: _autoSelect */
18774
18839
  /** {@inheritDoc ISheet.getSelection} */
@@ -18786,7 +18851,7 @@ export declare class Sheet implements ISheet {
18786
18851
  /** {@inheritDoc ISheet.getColumnHeaders} */
18787
18852
  getColumnHeaders(): ISheetHeader;
18788
18853
  /** {@inheritDoc ISheet.toJSON} */
18789
- toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
18854
+ toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
18790
18855
  /** {@inheritDoc ISheet.getStyles} */
18791
18856
  getStyles(): IStyleCollection;
18792
18857
  /** {@inheritDoc ISheet.getResources} */
@@ -18972,7 +19037,7 @@ declare class SheetHeader implements ISheetHeader {
18972
19037
  constructor(options: SheetHeader.ConstructorOptions);
18973
19038
  /** {@inheritDoc IListener.ISource.addListeners} */
18974
19039
  addListeners(listeners: ISheetHeader.IListeners, options?: IListener.Options): IListener.Remove;
18975
- protected _invalidSizes(): void;
19040
+ protected _invalidSizes(force?: boolean): void;
18976
19041
  protected _onHeaderChange(): void;
18977
19042
  /** {@inheritDoc ISheetHeader.getSheet} */
18978
19043
  getSheet(): ISheet;
@@ -20882,7 +20947,7 @@ export declare class Workbook implements IWorkbook {
20882
20947
  /* Excluded from this release type: _validateDeleteSheet */
20883
20948
  /* Excluded from this release type: _findOffsetForId */
20884
20949
  /** {@inheritDoc IWorkbook.find} */
20885
- find(text: string, options?: ICellRange.FindOptions): Iterator<ICell>;
20950
+ find(options: string | ICellRange.FindOptions): Iterator<ICell>;
20886
20951
  /** {@inheritDoc IWorkbook.replace} */
20887
20952
  replace(cells: Iterator<ICell>, replace: ICell.Update | ((original: ICell) => ICell.Update), options?: IWorkbook.ReplaceOptions): IWorkbook.ReplaceResults;
20888
20953
  /* Excluded from this release type: _nextSheetIndex */
@@ -20927,7 +20992,7 @@ export declare class Workbook implements IWorkbook {
20927
20992
  /* Excluded from this release type: _fromJSON */
20928
20993
  /* Excluded from this release type: _createScripts */
20929
20994
  /** {@inheritDoc IWorkbook.toJSON} */
20930
- toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
20995
+ toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
20931
20996
  /** {@inheritDoc IWorkbook.isClosed} */
20932
20997
  isClosed(): boolean;
20933
20998
  /** {@inheritDoc IWorkbook.close} */