@sheetxl/sdk 0.7.5 → 0.7.6

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 (86) hide show
  1. package/browser/cjs/{BpHhKYxVUE265JBy.cjs → B2UodXpOUlHSIzTE.cjs} +1 -1
  2. package/browser/cjs/{DHOe_V_hKlMrqhPa.cjs → B3YChoE8uWYsB8po.cjs} +1 -1
  3. package/browser/cjs/{DFFp9xTUre2rVHh7.cjs → BZAZH_QaXxk759nf.cjs} +1 -1
  4. package/browser/cjs/{D9qztL5pQdlbhPYb.cjs → BZfhxke18dRksnQh.cjs} +1 -1
  5. package/browser/cjs/{ByE2d5HXZEmqw0TU.cjs → BgiB4XbmHXoBeMWF.cjs} +1 -1
  6. package/browser/cjs/{sJWTx_katnHrL8aQ.cjs → BhHMwt5EMpxbIO1H.cjs} +1 -1
  7. package/browser/cjs/{DlV7J9o9tqVflPjn.cjs → BuqLM2n-G-8Ui2F7.cjs} +3 -3
  8. package/browser/cjs/{DL9orrPq0c2V3f4p.cjs → C2_540YzBFF_QkDW.cjs} +1 -1
  9. package/browser/cjs/{1S0sMZK1s3N0t33u.cjs → CEtIcmQJ79QEYsHX.cjs} +1 -1
  10. package/browser/cjs/{BYGX2tERLck9VP-I.cjs → CJ-JCnqmrXv6jcq1.cjs} +1 -1
  11. package/browser/cjs/{4EiWm2KDG50E5y_6.cjs → CXkmHi9CjNO6gYPR.cjs} +1 -1
  12. package/browser/cjs/{-uqksHAnL5nEGWzv.cjs → C_VnfNj8tvpyEYog.cjs} +1 -1
  13. package/browser/cjs/{BbOpR3W-DLNUIz86.cjs → CaMZMnpoI0WtZTbE.cjs} +1 -1
  14. package/browser/cjs/{DS9Fw3nau1wrssIo.cjs → Cqy2wsiwafkaaIm8.cjs} +1 -1
  15. package/browser/cjs/{Cj__xB2cDhMEfpuf.cjs → DAf36QsWu-aUG8NR.cjs} +1 -1
  16. package/browser/cjs/{DL-5YQONnbSEBBU3.cjs → DJeZQ4TP0COwx3O5.cjs} +1 -1
  17. package/browser/cjs/{uu2pXKuh-tTKPFCA.cjs → DLCbJzSKGL4mz2Kg.cjs} +1 -1
  18. package/browser/cjs/{ySPPgh7lYvx5M3bd.cjs → DbK-bmadwvDP96VG.cjs} +1 -1
  19. package/browser/cjs/{CW9m55xnr4ii2KGx.cjs → DdsV7dwQvwbPY8fN.cjs} +2 -2
  20. package/browser/cjs/{T7IxGWAsvLKBsPNY.cjs → Dn8oMACSoivY4EOy.cjs} +2 -2
  21. package/browser/cjs/{cYybyubtWV2zdUHx.cjs → Dv9NPjCDXh75BR6a.cjs} +1 -1
  22. package/browser/cjs/{CRqbnBjSKaJZ62A6.cjs → GqxScT8Z6UJbzYyH.cjs} +1 -1
  23. package/browser/cjs/bc5m0TQg7Iw3Onom.cjs +55 -0
  24. package/browser/cjs/{DvGMYohGopEJSZau.cjs → cSC1y3rV2P0gjlRW.cjs} +1 -1
  25. package/browser/cjs/{D5Wtjsf65Eg-1sv6.cjs → gbRetbAohpiKzQhQ.cjs} +1 -1
  26. package/browser/cjs/{BGi5LnIyDdqMcLpx.cjs → gw50ngla3lsqtuyV.cjs} +1 -1
  27. package/browser/cjs/index.cjs +2 -2
  28. package/browser/cjs/{BtVqShTZ5IU3zfuI.cjs → lNxQ_AMcQbOPxqxj.cjs} +1 -1
  29. package/{node/esm/CG-R9aP7EhUTt5m3.mjs → browser/esm/3yGyCGozqXEE_Svv.mjs} +1 -1
  30. package/browser/esm/{DmoSyqtYZz8_paWe.mjs → B2kJPp2FBeibEpKP.mjs} +1 -1
  31. package/browser/esm/{DFlqgvalm7SiNKkG.mjs → B8luvRhebJCRtg4p.mjs} +2 -2
  32. package/browser/esm/{XNXF_ScnDx7iPyEX.mjs → B9OX1POR2H9SGVs8.mjs} +1 -1
  33. package/browser/esm/{B4hxTanwXZGIvFU3.mjs → B9qammonvxPsV8Iu.mjs} +1 -1
  34. package/browser/esm/{CwlFwvi_wo1zs0D9.mjs → BLDtS5iA1exqm98u.mjs} +1 -1
  35. package/browser/esm/{COR33mX_k3BQIpHk.mjs → BbFqDU0XLWpYAAWh.mjs} +3 -3
  36. package/browser/esm/{Bledbteg6YDr9AGf.mjs → BdFX2KKZjlTKZNcR.mjs} +1 -1
  37. package/{node/esm/C-pmirkhKx2LZTbS.mjs → browser/esm/BmtqxNpwt0GsUDOk.mjs} +1 -1
  38. package/{node/esm/Cs8IoYlfFo1u6Mi6.mjs → browser/esm/Bofhu64WxcOCKHmw.mjs} +1 -1
  39. package/browser/esm/{BRwHF3JsVMB8gXLb.mjs → BvNa8CReZ1U0Evf2.mjs} +1 -1
  40. package/browser/esm/{Dmp8O6bOZORqDaA9.mjs → C6uXPQDNQJQfUgTL.mjs} +1 -1
  41. package/browser/esm/{CQUfFgOC_wQL3Dy5.mjs → CFCLa0c2_SlLrvYp.mjs} +1 -1
  42. package/browser/esm/{tS6XyWF6FOqdHUMq.mjs → CJDLBKcsUVm3wUZo.mjs} +4424 -4400
  43. package/browser/esm/{DdE7db1pm5fSIFY0.mjs → CK44O-jioQqnJwi9.mjs} +1 -1
  44. package/browser/esm/{-1oXsCJphcxX9cfW.mjs → CUzLy8WK2Ct0bDsi.mjs} +1 -1
  45. package/browser/esm/{DGBej8oNEHx3Zoi5.mjs → CfHam9cHrr9o_pzU.mjs} +1 -1
  46. package/{node/esm/BDu0aHArby8vg7U7.mjs → browser/esm/Ciu-v7Am3JjYNeF3.mjs} +1 -1
  47. package/{node/esm/BbwH3LDSvzso_F-X.mjs → browser/esm/Cl00c7N-0p_J9ueD.mjs} +1 -1
  48. package/browser/esm/{F3Xo1gW8r-5VGO5E.mjs → Cn1dxSTCmglyaB2p.mjs} +1 -1
  49. package/browser/esm/{BHKbsa_gG3PMfvGW.mjs → Cu--bFW0A9F3eOBg.mjs} +1 -1
  50. package/browser/esm/{Ch8xiyO9VhbEpQCE.mjs → D-X8WkG0PAHeuAZ9.mjs} +1 -1
  51. package/browser/esm/{B7Ku6lQf0CRbqDja.mjs → DaYq0AErpGzt0TDL.mjs} +1 -1
  52. package/browser/esm/{B9G7xUIJQWP3L211.mjs → DptxrjfOlvBGROOc.mjs} +1 -1
  53. package/{node/esm/CfphR9xnSPYcNB_3.mjs → browser/esm/J9gqZ_riHTnXRbXR.mjs} +1 -1
  54. package/browser/esm/{Dfzyu9t6YtDdEBq6.mjs → O4HYxW1CK9LJ59k4.mjs} +2 -2
  55. package/browser/esm/index.mjs +2 -2
  56. package/browser/esm/{BMB-Kb_DHFCZVgHa.mjs → jJ7v5a6zu09dIALd.mjs} +1 -1
  57. package/{browser/esm/CG-R9aP7EhUTt5m3.mjs → node/esm/3yGyCGozqXEE_Svv.mjs} +1 -1
  58. package/node/esm/{C4hi8VdjdALkvIpc.mjs → 4TCSsIA1FcFUpZq3.mjs} +1 -1
  59. package/node/esm/{DmoSyqtYZz8_paWe.mjs → B2kJPp2FBeibEpKP.mjs} +1 -1
  60. package/node/esm/{B4hxTanwXZGIvFU3.mjs → B9qammonvxPsV8Iu.mjs} +1 -1
  61. package/node/esm/{CwlFwvi_wo1zs0D9.mjs → BLDtS5iA1exqm98u.mjs} +1 -1
  62. package/node/esm/{DGRAWwNBIeDuY9lv.mjs → Bg_rTo4xKokET-4k.mjs} +1 -1
  63. package/{browser/esm/C-pmirkhKx2LZTbS.mjs → node/esm/BmtqxNpwt0GsUDOk.mjs} +1 -1
  64. package/{browser/esm/Cs8IoYlfFo1u6Mi6.mjs → node/esm/Bofhu64WxcOCKHmw.mjs} +1 -1
  65. package/node/esm/{Cnx_k3Wt04uwJo6e.mjs → BuYmvitBD4AXa0au.mjs} +1 -1
  66. package/node/esm/{BRwHF3JsVMB8gXLb.mjs → BvNa8CReZ1U0Evf2.mjs} +1 -1
  67. package/node/esm/{D_a5ynfcojSuQk6a.mjs → CEFyYUoqP_lZR6j6.mjs} +1 -1
  68. package/node/esm/{DdE7db1pm5fSIFY0.mjs → CK44O-jioQqnJwi9.mjs} +1 -1
  69. package/node/esm/{DGBej8oNEHx3Zoi5.mjs → CfHam9cHrr9o_pzU.mjs} +1 -1
  70. package/node/esm/{CVSNo61E9p55B3H7.mjs → ChHVRl-XsyzH_zEo.mjs} +1 -1
  71. package/{browser/esm/BDu0aHArby8vg7U7.mjs → node/esm/Ciu-v7Am3JjYNeF3.mjs} +1 -1
  72. package/node/esm/{Bxod6mZNp8yk4B2q.mjs → CjGou4cuFLy0BTGR.mjs} +1 -1
  73. package/{browser/esm/BbwH3LDSvzso_F-X.mjs → node/esm/Cl00c7N-0p_J9ueD.mjs} +1 -1
  74. package/node/esm/{purzcgsLDsGsJTZU.mjs → Cl09BvfaM01sYDXU.mjs} +2 -2
  75. package/node/esm/{F3Xo1gW8r-5VGO5E.mjs → Cn1dxSTCmglyaB2p.mjs} +1 -1
  76. package/node/esm/{BcpKCEahFJP3CQdz.mjs → D79WI4obIT9MT4N9.mjs} +1 -1
  77. package/node/esm/{B7Ku6lQf0CRbqDja.mjs → DaYq0AErpGzt0TDL.mjs} +1 -1
  78. package/node/esm/{B9G7xUIJQWP3L211.mjs → DptxrjfOlvBGROOc.mjs} +1 -1
  79. package/node/esm/{BW8AXL-kVt_jrvZ7.mjs → GCNf-I5s0xvLW5do.mjs} +1 -1
  80. package/{browser/esm/CfphR9xnSPYcNB_3.mjs → node/esm/J9gqZ_riHTnXRbXR.mjs} +1 -1
  81. package/node/esm/index.mjs +3196 -3179
  82. package/node/esm/{BMB-Kb_DHFCZVgHa.mjs → jJ7v5a6zu09dIALd.mjs} +1 -1
  83. package/package.json +4 -4
  84. package/types/index.d.ts +38 -30
  85. package/types/scripting.d.ts +81 -62
  86. package/browser/cjs/ByUEJSU9dSKLxphy.cjs +0 -54
@@ -3788,7 +3788,7 @@ declare module "text/TextBoxAlignment" {
3788
3788
  }
3789
3789
  declare module "text/ITextFrame" {
3790
3790
  import { TextAlign as CSSTextAlign } from 'csstype';
3791
- import { Dimensions, Bounds, Rectangle } from '@sheetxl/utils';
3791
+ import type { Size, Bounds, Rectangle } from '@sheetxl/utils';
3792
3792
  import { TextVisitor } from "text/TextVisitor";
3793
3793
  import { ITextLine } from "text/TextLine";
3794
3794
  import { ITextParagraph } from "text/TextParagraph";
@@ -3830,7 +3830,7 @@ declare module "text/ITextFrame" {
3830
3830
  *
3831
3831
  * @param dimensions will cause the text to wrap. If bounds are not specified or only a dimension then it will not wrap.
3832
3832
  */
3833
- layout(dimensions?: Partial<Dimensions>): ITextFrame;
3833
+ layout(dimensions?: Partial<Size>): ITextFrame;
3834
3834
  /**
3835
3835
  * This is the bound of a textfield include any whitespace
3836
3836
  */
@@ -4801,7 +4801,7 @@ declare module "text/richtext/IStyledFont" {
4801
4801
  * Additionally due to the nature of css having different properties for the same logic value
4802
4802
  * (for example color, backgroundColor)
4803
4803
  */
4804
- toCSS(darkMode?: boolean, zoom?: number, excludeNormal?: boolean): CSSProperties;
4804
+ toCSS(darkMode?: boolean, zoom?: number, ignoreNormal?: boolean): CSSProperties;
4805
4805
  /**
4806
4806
  * Serializes to a JSON object.
4807
4807
  */
@@ -7249,7 +7249,7 @@ declare module "numFmt/index" {
7249
7249
  }
7250
7250
  }
7251
7251
  declare module "style/IStyle" {
7252
- import { Dimensions, Rectangle } from '@sheetxl/utils';
7252
+ import type { Size, Rectangle } from '@sheetxl/utils';
7253
7253
  import { IProperties } from "type/index";
7254
7254
  import { ITransaction } from "transaction/index";
7255
7255
  import { ICellRange } from "cellRange/index";
@@ -7381,7 +7381,7 @@ declare module "style/IStyle" {
7381
7381
  /**
7382
7382
  * Returns the best fit size assuming no content.
7383
7383
  */
7384
- getBestFit(): Partial<Dimensions> | null;
7384
+ getBestFit(): Partial<Size> | null;
7385
7385
  /**
7386
7386
  * Returns insets used for content. This does not taking into account indent because
7387
7387
  * this is alignment and type specific.
@@ -8918,7 +8918,7 @@ declare module "table/ITableCollection" {
8918
8918
  *
8919
8919
  * @defaultValue false
8920
8920
  */
8921
- excludeHidden?: boolean;
8921
+ ignoreHidden?: boolean;
8922
8922
  /**
8923
8923
  * Only return items that are completely contained with the filter bounds.
8924
8924
  *
@@ -15217,9 +15217,9 @@ declare module "workbook/IWorkbook" {
15217
15217
  /**
15218
15218
  * Serialize the workbook to a JSON.
15219
15219
  *
15220
- * @param excludeData If `true` only meta data about the workbook will be saved.
15220
+ * @param ignoreData If `true` only meta data about the workbook will be saved.
15221
15221
  */
15222
- toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
15222
+ toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
15223
15223
  /**
15224
15224
  * Returns any custom workbook options that are provided in constructor.
15225
15225
  */
@@ -16183,7 +16183,7 @@ declare module "sheet/_SheetMessages" {
16183
16183
  export const MODEL_CLOSED = "Sheet has been closed. No further operations are allowed.";
16184
16184
  export const ERROR_MODEL_DELETE = "Unable to delete.";
16185
16185
  export const ERROR_ITERATOR_CLOSED = "IteratorContext can only be used during visit.";
16186
- export const ERROR_ITERATOR_NO_CELL_CONTEXT = "IteratorContext can only return a cell if the forEach excludeCellDetails has not been set to false.";
16186
+ export const ERROR_ITERATOR_NO_CELL_CONTEXT = "IteratorContext can only return a cell if the forEach ignoreCellDetails has not been set to false.";
16187
16187
  export const ERROR_INTERNAL_LISTENER_READ_ONLY = "To write the listener must be registered with the wrTable.IListener option.";
16188
16188
  export const ERROR_ADDRESS_INVALID_SCOPE = "When using addresses directly from the sheet do not include the sheet name.";
16189
16189
  export const ERROR_MAX_VALUES: (max: number) => string;
@@ -16584,7 +16584,7 @@ declare module "autoFill/IAutoFill" {
16584
16584
  }
16585
16585
  }
16586
16586
  declare module "text/TextFrame" {
16587
- import { Dimensions, Bounds, Rectangle } from '@sheetxl/utils';
16587
+ import { type Size, type Bounds, type Rectangle } from '@sheetxl/utils';
16588
16588
  import { TextVisitor } from "text/TextVisitor";
16589
16589
  import { ITextLine } from "text/TextLine";
16590
16590
  import { ITextParagraph } from "text/TextParagraph";
@@ -16596,14 +16596,14 @@ declare module "text/TextFrame" {
16596
16596
  private _bounds;
16597
16597
  private _textBounds;
16598
16598
  private _lines;
16599
- private _lastLayoutDims;
16599
+ private _lastLayoutSize;
16600
16600
  private _lastLayout;
16601
16601
  private _defaultFont;
16602
16602
  private _alignment;
16603
16603
  constructor(overrides: Partial<ITextFrame>, defaultFont: IStyledFont, alignment: ITextBoxAlignment, lines?: ITextLine[], bounds?: Bounds, textBounds?: Bounds);
16604
16604
  visitParas(visitor: TextVisitor): void;
16605
16605
  visitLines(visitor: TextVisitor): void;
16606
- layout(dims?: Partial<Dimensions>): ITextFrame;
16606
+ layout(size?: Partial<Size>): ITextFrame;
16607
16607
  clone(visitor?: TextVisitor): ITextFrame;
16608
16608
  equals(other: ITextParagraph): boolean;
16609
16609
  /** {@inheritDoc ITextFrame.createTemporaryTextFrame} */
@@ -16707,7 +16707,7 @@ declare module "text/TextWrapper" {
16707
16707
  }
16708
16708
  }
16709
16709
  declare module "text/_TextUtils" {
16710
- import { Dimensions } from '@sheetxl/utils';
16710
+ import { type Size } from '@sheetxl/utils';
16711
16711
  import { IFont } from "font/index";
16712
16712
  import { ITextFrame } from "text/ITextFrame";
16713
16713
  import { ITextBoxAlignment } from "text/TextBoxAlignment";
@@ -16720,7 +16720,7 @@ declare module "text/_TextUtils" {
16720
16720
  * @param dimensions
16721
16721
  * @param textMeasurer This defaults to a canvas context
16722
16722
  */
16723
- export const layoutTextFrame: (textFrame: ITextFrame, defaultFont: IStyledFont, alignment: ITextBoxAlignment, dimensions?: Partial<Dimensions>, textMeasurer?: IFont.Measurer) => ITextFrame;
16723
+ export const layoutTextFrame: (textFrame: ITextFrame, defaultFont: IStyledFont, alignment: ITextBoxAlignment, dimensions?: Partial<Size>, textMeasurer?: IFont.Measurer) => ITextFrame;
16724
16724
  /**
16725
16725
  * Checks whether a string is entirely uppercase, lowercase, or mixed case.
16726
16726
  *
@@ -17055,7 +17055,7 @@ declare module "movable/IMovableCollection" {
17055
17055
  * Indicate if items that are in hidden headers or marked as hidden should be returned.
17056
17056
  * @defaultValue false
17057
17057
  */
17058
- excludeHidden?: boolean;
17058
+ ignoreHidden?: boolean;
17059
17059
  /**
17060
17060
  * The type to search for. If not provided all items will be returned.
17061
17061
  */
@@ -17440,7 +17440,7 @@ declare module "movable/MovableCollection" {
17440
17440
  }
17441
17441
  }
17442
17442
  declare module "picture/IPicture" {
17443
- import type { Dimensions } from '@sheetxl/utils';
17443
+ import type { Size } from '@sheetxl/utils';
17444
17444
  import type { IListener } from "listener/index";
17445
17445
  import type { IResource } from "resource/index";
17446
17446
  import type { IModel } from "model/index";
@@ -17486,7 +17486,7 @@ declare module "picture/IPicture" {
17486
17486
  /**
17487
17487
  * The size of the image without any constraints. This info is determined by the file.
17488
17488
  */
17489
- getNaturalDimensions(): Dimensions;
17489
+ getNaturalSize(): Size;
17490
17490
  /**
17491
17491
  * As a url that can be attached to the dom.
17492
17492
  */
@@ -18343,7 +18343,7 @@ declare module "conditional/IConditionalFormatCollection" {
18343
18343
  *
18344
18344
  * @defaultValue false
18345
18345
  */
18346
- excludeHidden?: boolean;
18346
+ ignoreHidden?: boolean;
18347
18347
  /**
18348
18348
  * Only return items that are completely contained with the search bounds.
18349
18349
  *
@@ -18838,7 +18838,7 @@ declare module "table/TableCollection" {
18838
18838
  private _add;
18839
18839
  private _get;
18840
18840
  private _getByName;
18841
- constructor(add: (address: ICellRange.Address, options: ITableCollection.AddOptions) => ITable, get: (address: ICellRanges.Address, excludeHidden: boolean, fullyContained: boolean) => ITable[], getByName: (name: string) => ITable);
18841
+ constructor(add: (address: ICellRange.Address, options: ITableCollection.AddOptions) => ITable, get: (address: ICellRanges.Address, ignoreHidden: boolean, fullyContained: boolean) => ITable[], getByName: (name: string) => ITable);
18842
18842
  /** {@inheritDoc ITableCollection.add} */
18843
18843
  add(address: ICellRange.Address, options?: ITableCollection.AddOptions): ITable;
18844
18844
  /** {@inheritDoc ITableCollection.getItems} */
@@ -19215,7 +19215,7 @@ declare module "conditional/ConditionalFormatCollection" {
19215
19215
  export class ConditionalFormatCollection implements IConditionalFormatCollection {
19216
19216
  private _add;
19217
19217
  private _get;
19218
- constructor(add: (address: ICellRange.Address, options: IConditionalFormatCollection.AddOptions) => IConditionalFormat, get: (address: ICellRanges.Address, excludeHidden: boolean, fullyContained: boolean) => IConditionalFormat[]);
19218
+ constructor(add: (address: ICellRange.Address, options: IConditionalFormatCollection.AddOptions) => IConditionalFormat, get: (address: ICellRanges.Address, ignoreHidden: boolean, fullyContained: boolean) => IConditionalFormat[]);
19219
19219
  /** {@inheritDoc IConditionalFormatCollection.add} */
19220
19220
  add(address: ICellRange.Address, options?: IConditionalFormatCollection.AddOptions): IConditionalFormat;
19221
19221
  /** {@inheritDoc IConditionalFormatCollection.getItems} */
@@ -19378,7 +19378,7 @@ declare module "sheet/protection/index" {
19378
19378
  export * from "sheet/protection/ISheetProtection";
19379
19379
  }
19380
19380
  declare module "utils/GeomUtils" {
19381
- import { Point, Dimensions, Bounds } from '@sheetxl/utils';
19381
+ import type { Point, Size, Bounds } from '@sheetxl/utils';
19382
19382
  /**
19383
19383
  * Return the union of to 2 bounds.
19384
19384
  * @remarks
@@ -19412,7 +19412,7 @@ declare module "utils/GeomUtils" {
19412
19412
  * Takes an an inner un-rotated dimension and an outer un-rotated dimension and then will return
19413
19413
  * an un-rotated rectangle that if rotated will fit inside the outer rectangle.
19414
19414
  */
19415
- export const clipToOuterRect: (dimInner: Dimensions, dimOuter: Dimensions, rotation?: number) => Dimensions;
19415
+ export const clipToOuterRect: (dimInner: Size, dimOuter: Size, rotation?: number) => Size;
19416
19416
  export const findIntersectMath: (p1: Point, p2: Point, min: number, max: number) => {
19417
19417
  min: number;
19418
19418
  max: number;
@@ -20254,7 +20254,7 @@ declare module "fill/_BuiltInPatterns" {
20254
20254
  declare module "sheet/style/SheetCellStyle" {
20255
20255
  import { Properties as CSSProperties } from 'csstype';
20256
20256
  import { IRange } from '@sheetxl/primitives';
20257
- import { Dimensions, Rectangle, Bounds } from '@sheetxl/utils';
20257
+ import { type Size, type Rectangle, type Bounds } from '@sheetxl/utils';
20258
20258
  import { IProperties } from "type/index";
20259
20259
  import { IColor } from "color/index";
20260
20260
  import { IFill } from "fill/index";
@@ -20420,7 +20420,7 @@ declare module "sheet/style/SheetCellStyle" {
20420
20420
  export class CellFont extends Inheritable<IStyledFont.Properties, IStyledFont.JSON> implements IStyledFont {
20421
20421
  isEqualMeasure(other: IStyledFont): boolean;
20422
20422
  /** {@inheritDoc IStyle.toCSS} */
20423
- toCSS(darkMode?: boolean, zoom?: number, excludeNormal?: boolean): CSSProperties;
20423
+ toCSS(darkMode?: boolean, zoom?: number, ignoreNormal?: boolean): CSSProperties;
20424
20424
  /** {@inheritDoc IStyle.isSuperSub} */
20425
20425
  isSuperSub(): boolean;
20426
20426
  /** {@inheritDoc IStyle.isSuperSub} */
@@ -20572,7 +20572,7 @@ declare module "sheet/style/SheetCellStyle" {
20572
20572
  export class SheetCellStyle implements IStyle {
20573
20573
  protected _o: CreateCellStyleOptions;
20574
20574
  protected _p: InheritableProperties<IStyle.Properties, IStyle.JSON>;
20575
- protected _bestFit: Partial<Dimensions>;
20575
+ protected _bestFit: Partial<Size>;
20576
20576
  protected _insets: Rectangle;
20577
20577
  protected _hasVisibleStyling: boolean;
20578
20578
  constructor(options: CreateCellStyleOptions);
@@ -20591,7 +20591,7 @@ declare module "sheet/style/SheetCellStyle" {
20591
20591
  /** {@inheritDoc IStyle.update} */
20592
20592
  update(update: IStyle.Update, options?: IStyle.UpdateOptions): IStyle;
20593
20593
  /** {@inheritDoc IStyle.getBestFit} */
20594
- getBestFit(): Partial<Dimensions> | null;
20594
+ getBestFit(): Partial<Size> | null;
20595
20595
  /** {@inheritDoc IStyle.getInsets} */
20596
20596
  getInsets(): Rectangle;
20597
20597
  /** {@inheritDoc IStyle.getBorder} */
@@ -20915,7 +20915,7 @@ declare module "calculation/spatial/index" {
20915
20915
  }
20916
20916
  declare module "sheet/_SheetTypes" {
20917
20917
  import { ScalarType, Scalar, IRange } from '@sheetxl/primitives';
20918
- import type { Dimensions, Rectangle } from '@sheetxl/utils';
20918
+ import type { Size, Rectangle } from '@sheetxl/utils';
20919
20919
  import { IProperties } from "type/index";
20920
20920
  import { NumberFormat } from "numFmt/index";
20921
20921
  import type { ITextFrame } from "text/index";
@@ -20967,7 +20967,7 @@ declare module "sheet/_SheetTypes" {
20967
20967
  * @cacheValue
20968
20968
  */
20969
20969
  i?: Readonly<Rectangle>;
20970
- o?: Readonly<Partial<Dimensions>> | null;
20970
+ o?: Readonly<Partial<Size>> | null;
20971
20971
  w?: readonly string[] | null;
20972
20972
  B?: any;
20973
20973
  b?: any;
@@ -21051,7 +21051,7 @@ declare module "sheet/_SheetTypes" {
21051
21051
  interface IteratorOptions extends OverlappingRange.IteratorOptions {
21052
21052
  includeRangeTypes: boolean | SearchTypes;
21053
21053
  bounds?: IRange.Coords;
21054
- excludeHidden?: boolean | IRange.Orientation;
21054
+ ignoreHidden?: boolean | IRange.Orientation;
21055
21055
  includeMergeOverflow?: boolean;
21056
21056
  }
21057
21057
  interface Entry {
@@ -21421,7 +21421,7 @@ declare module "numFmt/_FormatCell" {
21421
21421
  }
21422
21422
  declare module "sheet/SheetCell" {
21423
21423
  import { Scalar, ScalarType, IRange, FormulaError } from '@sheetxl/primitives';
21424
- import { Dimensions, Rectangle } from '@sheetxl/utils';
21424
+ import { type Size, type Rectangle } from '@sheetxl/utils';
21425
21425
  import { IProperties, ITypes } from "type/index";
21426
21426
  import { NumberFormat } from "numFmt/index";
21427
21427
  import { ITextFrame } from "text/index";
@@ -21480,7 +21480,7 @@ declare module "sheet/SheetCell" {
21480
21480
  /** Guaranteed to never return null */
21481
21481
  export const csStyle: (specific: boolean, range: IRange.Coords, intersection: RangeState.Intersection, options: SheetCellOptions) => IStyle;
21482
21482
  export const csBestFit: (type: ScalarType, style: IStyle, value: Scalar, options: SheetCellOptions, colWidth: number, isMinContent: boolean, isRowOnly: boolean, // if true we only measure the height
21483
- customHash?: string, cache?: Cache<string, Readonly<Partial<Dimensions>>>) => Readonly<Partial<Dimensions>>;
21483
+ customHash?: string, cache?: Cache<string, Readonly<Partial<Size>>>) => Readonly<Partial<Size>>;
21484
21484
  export interface SheetCellOptions {
21485
21485
  resolveRange: (address?: ICellRange.Address) => ICellRange | null;
21486
21486
  sheet: ISheet;
@@ -21540,7 +21540,7 @@ declare module "sheet/SheetCell" {
21540
21540
  /** {@inheritDoc ICell.isContentful} */
21541
21541
  isContentful(): boolean;
21542
21542
  /** {@inheritDoc ICell.getBestFit} */
21543
- getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Dimensions>> | null;
21543
+ getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
21544
21544
  /** {@inheritDoc ICell.getInsets} */
21545
21545
  getInsets(): Rectangle;
21546
21546
  /** {@inheritDoc ICell.getTextFrame} */
@@ -21565,7 +21565,7 @@ declare module "sheet/SheetCell" {
21565
21565
  /** {@inheritDoc ICell.toDate} */
21566
21566
  toDate(): Date | null;
21567
21567
  /** {@inheritDoc ICell.toText} */
21568
- toText(numFmt?: string): string;
21568
+ toText(): string;
21569
21569
  /** {@inheritDoc ICell.toTextUnformatted} */
21570
21570
  toTextUnformatted(showFormula?: boolean): string;
21571
21571
  /** {@inheritDoc ICell.getComments} */
@@ -21577,7 +21577,7 @@ declare module "sheet/SheetCell" {
21577
21577
  /** {@inheritDoc ICell.getWarnings} */
21578
21578
  getWarnings(): readonly string[];
21579
21579
  /** {@inheritDoc ICell.getSpans} */
21580
- getSpans(): Readonly<Dimensions>;
21580
+ getSpans(): Readonly<Size>;
21581
21581
  /** {@inheritDoc ICell.isTopLeft} */
21582
21582
  isTopLeft(): boolean;
21583
21583
  /** {@inheritDoc ICell.getSpill} */
@@ -21640,7 +21640,7 @@ declare module "sheet/SheetRanges" {
21640
21640
  import type { IStyle } from "style/index";
21641
21641
  import type { ISheet } from "sheet/index";
21642
21642
  export interface SheetRangesOptions {
21643
- excludeHidden?: boolean;
21643
+ ignoreHidden?: boolean;
21644
21644
  readOnly?: string;
21645
21645
  getOptions: ICellRange.GetRangeOptions;
21646
21646
  }
@@ -21780,7 +21780,7 @@ declare module "calculation/graph/_CalcGraphUtils" {
21780
21780
  }
21781
21781
  declare module "sheet/Sheet" {
21782
21782
  import { Scalar, JSScalar, IRange } from '@sheetxl/primitives';
21783
- import { Dimensions, type Bounds, CoordUtils } from '@sheetxl/utils';
21783
+ import { Size, type Bounds, CoordUtils } from '@sheetxl/utils';
21784
21784
  import { ITypes, ICollection, IProperties } from "type/index";
21785
21785
  import type { IWorkbook } from "workbook/index";
21786
21786
  import type { IListener } from "listener/index";
@@ -21899,7 +21899,7 @@ declare module "sheet/Sheet" {
21899
21899
  options: ICellRange.ListenerOptions;
21900
21900
  }
21901
21901
  interface GetRangeEntriesOptions<T = any, E = any> {
21902
- excludeHidden?: boolean | IRange.Orientation;
21902
+ ignoreHidden?: boolean | IRange.Orientation;
21903
21903
  fullyContained?: boolean;
21904
21904
  onEntry?: (value: E, entry: ISpatialMap.Entry<T>) => T | void;
21905
21905
  noCache?: boolean;
@@ -22025,7 +22025,7 @@ declare module "sheet/Sheet" {
22025
22025
  };
22026
22026
  protected _lastGetRangeRead: Record<string, {
22027
22027
  ranges: readonly IRange.Coords[];
22028
- excludeHidden: boolean | IRange.Orientation;
22028
+ ignoreHidden: boolean | IRange.Orientation;
22029
22029
  results: any[];
22030
22030
  }>;
22031
22031
  protected _lastUsedCoordsRead: {
@@ -22068,7 +22068,7 @@ declare module "sheet/Sheet" {
22068
22068
  protected _closed: boolean;
22069
22069
  protected _defaultColWidthCache: number;
22070
22070
  protected _defaultRowHeightCache: number;
22071
- protected _defaultFontBoundsCache: Readonly<Dimensions>;
22071
+ protected _defaultFontBoundsCache: Readonly<Size>;
22072
22072
  constructor(options?: ISheet.ConstructorOptions);
22073
22073
  /** @internal */
22074
22074
  protected _createRange(coords: Readonly<IRange.FixableCoords>, getOptions?: ICellRange.GetRangeOptions, readOnly?: string): ICellRange;
@@ -22189,7 +22189,7 @@ declare module "sheet/Sheet" {
22189
22189
  /** @internal */
22190
22190
  protected _unmerge(ranges: readonly IRange.Coords[], options?: ITransaction.OperationOptions): void;
22191
22191
  /** @internal */
22192
- protected _getMerges(ranges: readonly IRange.Coords[], excludeHidden?: boolean | IRange.Orientation): IRange.Coords[];
22192
+ protected _getMerges(ranges: readonly IRange.Coords[], ignoreHidden?: boolean | IRange.Orientation): IRange.Coords[];
22193
22193
  /** @internal */
22194
22194
  protected _clone(): ISheet;
22195
22195
  /** @internal */
@@ -22271,11 +22271,11 @@ declare module "sheet/Sheet" {
22271
22271
  /** @internal */
22272
22272
  protected _getUsedCoords(_options?: ICellRange.GetRangeOptions): IRange.Coords | null;
22273
22273
  /** @internal */
22274
- protected _isContentful(ranges: readonly IRange.Coords[], excludeHidden?: boolean | IRange.Orientation): boolean;
22274
+ protected _isContentful(ranges: readonly IRange.Coords[], ignoreHidden?: boolean | IRange.Orientation): boolean;
22275
22275
  /** @internal */
22276
- protected _getCount(coords: IRange.Coords[], excludeHidden?: boolean): number;
22276
+ protected _getCount(coords: IRange.Coords[], ignoreHidden?: boolean): number;
22277
22277
  /** @internal */
22278
- protected _contentCounts(ranges: readonly IRange.Coords[], types: ICell.Content[], excludeHidden: boolean | IRange.Orientation): ICellRange.Counts;
22278
+ protected _contentCounts(ranges: readonly IRange.Coords[], types: ICell.Content[], ignoreHidden: boolean | IRange.Orientation): ICellRange.Counts;
22279
22279
  /** {@inheritDoc ISheet.getSelectedCell} */
22280
22280
  getSelectedCell(): ICell;
22281
22281
  /** {@inheritDoc ISheet.find} */
@@ -22289,7 +22289,7 @@ declare module "sheet/Sheet" {
22289
22289
  /** @internal */
22290
22290
  protected _extendRange(direction: IRange.Direction, coords: IRange.CellCoords): Readonly<IRange.Coords>;
22291
22291
  /** @internal */
22292
- protected _defaultFontDims(): Readonly<Dimensions>;
22292
+ protected _defaultFontDims(): Readonly<Size>;
22293
22293
  /** {@inheritDoc ISheet.getColumnWidthAsFontUnit} */
22294
22294
  getColumnWidthAsFontUnit(pixelWidth: number): number;
22295
22295
  /**
@@ -22327,7 +22327,7 @@ declare module "sheet/Sheet" {
22327
22327
  /** {@inheritDoc ISheet.getColumnHeaders} */
22328
22328
  getColumnHeaders(): ISheetHeader;
22329
22329
  /** {@inheritDoc ISheet.toJSON} */
22330
- toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
22330
+ toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
22331
22331
  /** {@inheritDoc ISheet.getStyles} */
22332
22332
  getStyles(): IStyleCollection;
22333
22333
  /** {@inheritDoc ISheet.getResources} */
@@ -22462,7 +22462,7 @@ declare module "sheet/SheetRange" {
22462
22462
  import type { ISheet } from "sheet/ISheet";
22463
22463
  import { Sheet } from "sheet/Sheet";
22464
22464
  export interface SheetRangeOptions {
22465
- excludeHidden?: boolean;
22465
+ ignoreHidden?: boolean;
22466
22466
  readOnly?: string;
22467
22467
  getOptions: ICellRange.GetRangeOptions;
22468
22468
  }
@@ -22510,6 +22510,8 @@ declare module "sheet/SheetRange" {
22510
22510
  protected _setValueOrValues(value: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
22511
22511
  /** {@inheritDoc ICellRange.getValues} */
22512
22512
  getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
22513
+ /** {@inheritDoc ICellRange.toText} */
22514
+ toText(options?: ICellRange.ToTextOptions): string;
22513
22515
  /** {@inheritDoc ICellRange.getValues} */
22514
22516
  getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
22515
22517
  /** {@inheritDoc ICellRange.calculate} */
@@ -22948,7 +22950,7 @@ declare module "workbook/Workbook" {
22948
22950
  /** @internal */
22949
22951
  protected _createScripts(json?: Record<string, IModule.JSON>): IScript;
22950
22952
  /** {@inheritDoc IWorkbook.toJSON} */
22951
- toJSON(excludeData?: boolean): Promise<IWorkbook.JSON>;
22953
+ toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
22952
22954
  /** {@inheritDoc IWorkbook.isClosed} */
22953
22955
  isClosed(): boolean;
22954
22956
  /** {@inheritDoc IWorkbook.close} */
@@ -23610,9 +23612,9 @@ declare module "sheet/ISheet" {
23610
23612
  /**
23611
23613
  * Returns a JSON representation of the sheet.
23612
23614
  *
23613
- * @param excludeData If `true` only meta data about the sheet will be saved.
23615
+ * @param ignoreData If `true` only meta data about the sheet will be saved.
23614
23616
  */
23615
- toJSON(excludeData?: boolean): Promise<ISheet.JSON>;
23617
+ toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
23616
23618
  /**
23617
23619
  * Free all resources associated with the sheet.
23618
23620
  *
@@ -24350,8 +24352,17 @@ declare module "sheet/_SheetUtils" {
24350
24352
  * @internal
24351
24353
  */
24352
24354
  export const mergeRangeStateIntersections: (ranges: readonly ITypes.RangeCoordValue<RangeState.Intersection>[]) => RangeState.Intersection;
24353
- /** @internal */
24355
+ /**
24356
+ * @internal
24357
+ * * TODO - Use a lower level iterator to avoid cell context?
24358
+ */
24354
24359
  export const cellStateIteratorTo2DArray: (iteratorCallback: (options?: CellState.IteratorOptions) => Iterator<ICellRange.Entry, ICellRange.Entry, IRange.CellCoords>, bounds: IRange.Coords, asCells: boolean, options: ICellRange.GetValuesOptions) => (ICell | JSScalar)[][];
24360
+ /**
24361
+ * @internal
24362
+ * TODO - rationalize this with cellStateIteratorTo2DArray?
24363
+ * TODO - Use a lower level iterator to avoid cell context?
24364
+ */
24365
+ export const cellStateIteratorToString: (iteratorCallback: (options?: CellState.IteratorOptions) => Iterator<ICellRange.Entry, ICellRange.Entry, IRange.CellCoords>, bounds: IRange.Coords, options: ICellRange.ToTextOptions) => string;
24355
24366
  export const isEqualSheetRanges: (a?: IRange.FixableCoords, b?: IRange.FixableCoords) => boolean;
24356
24367
  /**
24357
24368
  * Check if two ranges arrays are equal
@@ -29795,7 +29806,7 @@ declare module "cell/ICellProtection" {
29795
29806
  }
29796
29807
  declare module "cell/ICell" {
29797
29808
  import type { Scalar, JSScalarUpdate, ScalarType, IRange } from '@sheetxl/primitives';
29798
- import type { Dimensions, Rectangle, Bounds } from '@sheetxl/utils';
29809
+ import type { Size, Rectangle, Bounds } from '@sheetxl/utils';
29799
29810
  import type { ITypes } from "type/index";
29800
29811
  import type { ITextFrame } from "text/index";
29801
29812
  import type { NumberFormat } from "numFmt/index";
@@ -29886,12 +29897,10 @@ declare module "cell/ICell" {
29886
29897
  /**
29887
29898
  * Returns the cell's value as a formatted string, applying any number formatting.
29888
29899
  *
29889
- * @param numFmt A custom number format to apply (optional).
29890
- *
29891
29900
  * @see
29892
29901
  * {@link toTextUnformatted}
29893
29902
  */
29894
- toText(numFmt?: string): string;
29903
+ toText(): string;
29895
29904
  /**
29896
29905
  * Returns the cell's value as an unformatted string.
29897
29906
  *
@@ -29938,7 +29947,7 @@ declare module "cell/ICell" {
29938
29947
  * Returns `null` if this cell should be ignored for sizing purposes.
29939
29948
  * Either dimension can also be `null`, indicating that the specific direction should not be used.
29940
29949
  */
29941
- getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Dimensions>> | null;
29950
+ getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
29942
29951
  /**
29943
29952
  * Returns protection information.
29944
29953
  */
@@ -29953,7 +29962,7 @@ declare module "cell/ICell" {
29953
29962
  /**
29954
29963
  * Returns the span dimensions for merged cells.
29955
29964
  */
29956
- getSpans(): Readonly<Dimensions>;
29965
+ getSpans(): Readonly<Size>;
29957
29966
  /**
29958
29967
  * Returns `true` if the cell is the top-left cell of a merged region, or if it is not part of a merged region.
29959
29968
  */
@@ -31459,7 +31468,7 @@ declare module "sort/ISort" {
31459
31468
  interface DefaultSortCriteria {
31460
31469
  /**
31461
31470
  * The cords that will be sorted.
31462
- * This may exclude the header.
31471
+ * This may ignore the header.
31463
31472
  */
31464
31473
  coords: IRange.Coords;
31465
31474
  /**
@@ -32003,7 +32012,7 @@ declare module "cellRange/ICellHeaderRange" {
32003
32012
  * optionally a header orientation for skipping case be passed in.
32004
32013
  * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
32005
32014
  */
32006
- excludeHidden?: boolean;
32015
+ ignoreHidden?: boolean;
32007
32016
  }
32008
32017
  /**
32009
32018
  * Context for Iterators to provide access to the `IRange.CellCoords`, the `ICellHeader`, and additional operators.
@@ -32199,7 +32208,7 @@ declare module "cellRange/ICellRange" {
32199
32208
  * Returns the value for the top left `Scalar`.
32200
32209
  *
32201
32210
  * @remarks
32202
- * The `excludeHidden` option is ignored.
32211
+ * The `ignoreHidden` option is ignored.
32203
32212
  *
32204
32213
  * @see
32205
32214
  * {@link ICellRange.getValues}
@@ -32409,6 +32418,10 @@ declare module "cellRange/ICellRange" {
32409
32418
  * * Setting {@link ICellRange.GetValuesOptions.asJSDate} to `true` will add make slower.
32410
32419
  */
32411
32420
  getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
32421
+ /**
32422
+ * Returns the range value as a string.
32423
+ */
32424
+ toText(options?: ICellRange.ToTextOptions): string;
32412
32425
  /**
32413
32426
  * Set the value(s) of one or more cells within a range.
32414
32427
  *
@@ -33068,10 +33081,16 @@ declare module "cellRange/ICellRange" {
33068
33081
  * - Optionally, you can specify a `IRange.Orientation` to indicate the header orientation for skipping cases.
33069
33082
  * For example, in sorting, you might want to skip hidden rows but not hidden columns.
33070
33083
  */
33071
- excludeHidden?: boolean | IRange.Orientation;
33084
+ ignoreHidden?: boolean | IRange.Orientation;
33072
33085
  /** {@inheritDoc ICellRange.IteratorOptions.includeMergeOverflow} */
33073
33086
  includeMergeOverflow?: boolean;
33074
33087
  }
33088
+ /**
33089
+ * Options for {@link ICellRange.toText}.
33090
+ */
33091
+ interface ToTextOptions extends ICellRange.GetValuesOptions {
33092
+ ignoreFormatting?: boolean;
33093
+ }
33075
33094
  /**
33076
33095
  * Options for {@link ICellRange.autoFit}.
33077
33096
  */
@@ -33510,7 +33529,7 @@ declare module "cellRange/ICellRange" {
33510
33529
  * Optionally a header orientation for skipping case be passed in.
33511
33530
  * An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
33512
33531
  */
33513
- excludeHidden?: boolean | IRange.Orientation;
33532
+ ignoreHidden?: boolean | IRange.Orientation;
33514
33533
  /**
33515
33534
  * If set to true the only the raw values will be visited.
33516
33535
  *
@@ -33519,7 +33538,7 @@ declare module "cellRange/ICellRange" {
33519
33538
  * @remarks
33520
33539
  * This allows for much faster reading when only the value is needed.
33521
33540
  */
33522
- excludeCellDetails?: boolean;
33541
+ ignoreCellDetails?: boolean;
33523
33542
  /**
33524
33543
  * Includes any merge overflow in first element visited.
33525
33544
  *