@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.
- package/LICENSE.md +1 -1
- package/browser/cjs/{cYybyubtWV2zdUHx.cjs → 6YiDKvszb4QTKhmb.cjs} +1 -1
- package/browser/cjs/{1S0sMZK1s3N0t33u.cjs → B-6AVAWj0wJFR6dO.cjs} +1 -1
- package/browser/cjs/{DlV7J9o9tqVflPjn.cjs → B4VVw60UQ3vfbmle.cjs} +3 -3
- package/browser/cjs/{DFFp9xTUre2rVHh7.cjs → B87MiIGIWM1CB19b.cjs} +1 -1
- package/browser/cjs/{BtVqShTZ5IU3zfuI.cjs → BCpzIReLJoNRLVU1.cjs} +1 -1
- package/browser/cjs/{DL-5YQONnbSEBBU3.cjs → BDHMsNmKJeWqQ_Ah.cjs} +1 -1
- package/browser/cjs/{ByE2d5HXZEmqw0TU.cjs → BShLA4Kkh0AOYVTh.cjs} +1 -1
- package/browser/cjs/{CRqbnBjSKaJZ62A6.cjs → BiPuVsv5UeujokJw.cjs} +1 -1
- package/browser/cjs/{BGi5LnIyDdqMcLpx.cjs → Bov0O9MprKKSLEUN.cjs} +1 -1
- package/browser/cjs/{-uqksHAnL5nEGWzv.cjs → C0Uiuy-T67-6jfdk.cjs} +1 -1
- package/browser/cjs/{DS9Fw3nau1wrssIo.cjs → C2fwewNOX7IjJnUs.cjs} +1 -1
- package/browser/cjs/{D5Wtjsf65Eg-1sv6.cjs → C4qak2P9P1Py4Tfa.cjs} +1 -1
- package/browser/cjs/{DvGMYohGopEJSZau.cjs → CCEkxp3l_zc6hwFz.cjs} +1 -1
- package/browser/cjs/{Cj__xB2cDhMEfpuf.cjs → CG-8zldtiozHdU6d.cjs} +1 -1
- package/browser/cjs/{BYGX2tERLck9VP-I.cjs → CRkHJ_23CST6gsS4.cjs} +1 -1
- package/browser/cjs/{DHOe_V_hKlMrqhPa.cjs → Ce8ERxKLMH8eLe_5.cjs} +1 -1
- package/browser/cjs/{DL9orrPq0c2V3f4p.cjs → ChJbzGbiVBCnGaGa.cjs} +1 -1
- package/browser/cjs/{D9qztL5pQdlbhPYb.cjs → ChUr9QKfIL7vF_B0.cjs} +1 -1
- package/browser/cjs/{CW9m55xnr4ii2KGx.cjs → D95myDh-N6M7a6EC.cjs} +2 -2
- package/browser/cjs/{4EiWm2KDG50E5y_6.cjs → D9rERLaYDKUc9qch.cjs} +1 -1
- package/browser/cjs/{BpHhKYxVUE265JBy.cjs → DDa2Qn9hJAPjnhCH.cjs} +1 -1
- package/browser/cjs/{T7IxGWAsvLKBsPNY.cjs → DGC6f_6wlFM5VRrr.cjs} +2 -2
- package/browser/cjs/DGDPwgpaSETDtxCN.cjs +55 -0
- package/browser/cjs/{BbOpR3W-DLNUIz86.cjs → DeEljP-uvzcM34GT.cjs} +1 -1
- package/browser/cjs/{sJWTx_katnHrL8aQ.cjs → DfUeqUiL4bBlAhdF.cjs} +1 -1
- package/browser/cjs/index.cjs +2 -2
- package/browser/cjs/{ySPPgh7lYvx5M3bd.cjs → kqUd8g5hhQmjxw-7.cjs} +1 -1
- package/browser/cjs/{uu2pXKuh-tTKPFCA.cjs → slNr9hOAgryqEMyq.cjs} +1 -1
- package/{node/esm/BbwH3LDSvzso_F-X.mjs → browser/esm/3taHjNdnWalGdFoN.mjs} +1 -1
- package/browser/esm/{Dmp8O6bOZORqDaA9.mjs → 7fdgLbvHzfxbpwJ1.mjs} +1 -1
- package/browser/esm/{B4hxTanwXZGIvFU3.mjs → BDBDC-tU9iYsgoqc.mjs} +1 -1
- package/browser/esm/{XNXF_ScnDx7iPyEX.mjs → BHKlRr_d3a-Ya_Su.mjs} +1 -1
- package/browser/esm/{B9G7xUIJQWP3L211.mjs → BXqwtRYeKXwaRkV_.mjs} +1 -1
- package/browser/esm/{Bledbteg6YDr9AGf.mjs → BsoDrSnLS8G3AJ3u.mjs} +1 -1
- package/{node/esm/Cs8IoYlfFo1u6Mi6.mjs → browser/esm/C04EaRL-IaVpZrV6.mjs} +1 -1
- package/browser/esm/{BHKbsa_gG3PMfvGW.mjs → C11CU2VQMPa4WzZU.mjs} +1 -1
- package/browser/esm/{-1oXsCJphcxX9cfW.mjs → CARs01wGHA9RsDGg.mjs} +1 -1
- package/browser/esm/{Ch8xiyO9VhbEpQCE.mjs → CH5s8whBuz7_QNkE.mjs} +1 -1
- package/browser/esm/{F3Xo1gW8r-5VGO5E.mjs → CKgk76So3qcfcbsH.mjs} +1 -1
- package/{node/esm/CG-R9aP7EhUTt5m3.mjs → browser/esm/CmGeq0aRlEliSS5J.mjs} +1 -1
- package/browser/esm/{BRwHF3JsVMB8gXLb.mjs → D11ZnQb02ftmGbHB.mjs} +1 -1
- package/browser/esm/{B7Ku6lQf0CRbqDja.mjs → D2IBRYlusWRArNGL.mjs} +1 -1
- package/browser/esm/{DdE7db1pm5fSIFY0.mjs → D9xgLV4uaDpD4saH.mjs} +1 -1
- package/{node/esm/C-pmirkhKx2LZTbS.mjs → browser/esm/DCc4PEcMjmtt0eZS.mjs} +1 -1
- package/browser/esm/{Dfzyu9t6YtDdEBq6.mjs → DFDwDLLSOBJY-mTG.mjs} +2 -2
- package/{node/esm/CfphR9xnSPYcNB_3.mjs → browser/esm/DZBoAWNa-PcXWjXT.mjs} +1 -1
- package/browser/esm/{CwlFwvi_wo1zs0D9.mjs → DhD71gpoqktUC4-1.mjs} +1 -1
- package/browser/esm/{BMB-Kb_DHFCZVgHa.mjs → DpzqASL8k7y8SrVp.mjs} +1 -1
- package/browser/esm/{DFlqgvalm7SiNKkG.mjs → K9D_aiqdvcMIMQUn.mjs} +2 -2
- package/browser/esm/{COR33mX_k3BQIpHk.mjs → MhkAJnoTgT1NERew.mjs} +3 -3
- package/browser/esm/{DGBej8oNEHx3Zoi5.mjs → T6K4zXnAClxK-6of.mjs} +1 -1
- package/browser/esm/{CQUfFgOC_wQL3Dy5.mjs → Vyu4kkPirTv77rqZ.mjs} +1 -1
- package/browser/esm/{DmoSyqtYZz8_paWe.mjs → X0a-IoCuOBC1WZwO.mjs} +1 -1
- package/{node/esm/BDu0aHArby8vg7U7.mjs → browser/esm/gzqYXI3Fvz0T6OJ7.mjs} +1 -1
- package/browser/esm/index.mjs +2 -2
- package/browser/esm/{tS6XyWF6FOqdHUMq.mjs → lHzCw1GM3TwlAcTJ.mjs} +6717 -6667
- package/licenses/dependencies.txt +1 -1
- package/{browser/esm/BbwH3LDSvzso_F-X.mjs → node/esm/3taHjNdnWalGdFoN.mjs} +1 -1
- package/node/esm/{B4hxTanwXZGIvFU3.mjs → BDBDC-tU9iYsgoqc.mjs} +1 -1
- package/node/esm/{D_a5ynfcojSuQk6a.mjs → BDUMJbvVahP0qvqH.mjs} +1 -1
- package/node/esm/{Bxod6mZNp8yk4B2q.mjs → BK9r574tKB8mQ1x1.mjs} +1 -1
- package/node/esm/{C4hi8VdjdALkvIpc.mjs → BLkrfw6JvbKEo67o.mjs} +1 -1
- package/node/esm/{B9G7xUIJQWP3L211.mjs → BXqwtRYeKXwaRkV_.mjs} +1 -1
- package/node/esm/{DGRAWwNBIeDuY9lv.mjs → BjpcNcX4Vhv44YX4.mjs} +1 -1
- package/node/esm/{Cnx_k3Wt04uwJo6e.mjs → BkAqe5aH4ZS5iG3o.mjs} +1 -1
- package/{browser/esm/Cs8IoYlfFo1u6Mi6.mjs → node/esm/C04EaRL-IaVpZrV6.mjs} +1 -1
- package/node/esm/{F3Xo1gW8r-5VGO5E.mjs → CKgk76So3qcfcbsH.mjs} +1 -1
- package/{browser/esm/CG-R9aP7EhUTt5m3.mjs → node/esm/CmGeq0aRlEliSS5J.mjs} +1 -1
- package/node/esm/{BRwHF3JsVMB8gXLb.mjs → D11ZnQb02ftmGbHB.mjs} +1 -1
- package/node/esm/{B7Ku6lQf0CRbqDja.mjs → D2IBRYlusWRArNGL.mjs} +1 -1
- package/node/esm/{BcpKCEahFJP3CQdz.mjs → D2KbzMOkas3hur0w.mjs} +1 -1
- package/node/esm/{DdE7db1pm5fSIFY0.mjs → D9xgLV4uaDpD4saH.mjs} +1 -1
- package/{browser/esm/C-pmirkhKx2LZTbS.mjs → node/esm/DCc4PEcMjmtt0eZS.mjs} +1 -1
- package/node/esm/{CVSNo61E9p55B3H7.mjs → DNj6ugQcYOjrfvJw.mjs} +1 -1
- package/node/esm/{BW8AXL-kVt_jrvZ7.mjs → DTw4BKoGHXdSDlEk.mjs} +1 -1
- package/node/esm/{purzcgsLDsGsJTZU.mjs → DWOm2-5P3DAsRN9c.mjs} +2 -2
- package/{browser/esm/CfphR9xnSPYcNB_3.mjs → node/esm/DZBoAWNa-PcXWjXT.mjs} +1 -1
- package/node/esm/{CwlFwvi_wo1zs0D9.mjs → DhD71gpoqktUC4-1.mjs} +1 -1
- package/node/esm/{BMB-Kb_DHFCZVgHa.mjs → DpzqASL8k7y8SrVp.mjs} +1 -1
- package/node/esm/{DGBej8oNEHx3Zoi5.mjs → T6K4zXnAClxK-6of.mjs} +1 -1
- package/node/esm/{DmoSyqtYZz8_paWe.mjs → X0a-IoCuOBC1WZwO.mjs} +1 -1
- package/{browser/esm/BDu0aHArby8vg7U7.mjs → node/esm/gzqYXI3Fvz0T6OJ7.mjs} +1 -1
- package/node/esm/index.mjs +3216 -3188
- package/package.json +7 -7
- package/types/index.d.ts +118 -53
- package/types/scripting.d.ts +195 -116
- package/browser/cjs/ByUEJSU9dSKLxphy.cjs +0 -54
package/types/scripting.d.ts
CHANGED
|
@@ -1396,7 +1396,7 @@ declare module "type/ITypes" {
|
|
|
1396
1396
|
*
|
|
1397
1397
|
* @defaultValue false
|
|
1398
1398
|
*/
|
|
1399
|
-
scrollIntoView?: globalThis.ScrollIntoViewOptions
|
|
1399
|
+
scrollIntoView?: boolean | globalThis.ScrollIntoViewOptions;
|
|
1400
1400
|
/**
|
|
1401
1401
|
* If `true`, the selected element will automatically receive focus after being selected.
|
|
1402
1402
|
*
|
|
@@ -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 {
|
|
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<
|
|
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,
|
|
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 {
|
|
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<
|
|
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
|
-
|
|
8921
|
+
ignoreHidden?: boolean;
|
|
8922
8922
|
/**
|
|
8923
8923
|
* Only return items that are completely contained with the filter bounds.
|
|
8924
8924
|
*
|
|
@@ -14115,7 +14115,7 @@ declare module "calculation/formula/IFormulaParser" {
|
|
|
14115
14115
|
}
|
|
14116
14116
|
}
|
|
14117
14117
|
declare module "utils/_RangeCoordUtils" {
|
|
14118
|
-
import {
|
|
14118
|
+
import { IRange } from '@sheetxl/primitives';
|
|
14119
14119
|
/**
|
|
14120
14120
|
* This is a more advanced use case of ranges that takes an array of ranges and uses an r-tree algo to
|
|
14121
14121
|
* determine if the ranges intersects.
|
|
@@ -14123,7 +14123,7 @@ declare module "utils/_RangeCoordUtils" {
|
|
|
14123
14123
|
* @param ranges
|
|
14124
14124
|
* @returns A flag indicating if any of the ranges intersect.
|
|
14125
14125
|
*/
|
|
14126
|
-
export const rangesArrayIntersect: (ranges: readonly
|
|
14126
|
+
export const rangesArrayIntersect: (ranges: readonly IRange.Coords[]) => boolean;
|
|
14127
14127
|
/**
|
|
14128
14128
|
* Rolls a potential 2d array into a single array.
|
|
14129
14129
|
* @param array
|
|
@@ -14137,7 +14137,7 @@ declare module "utils/_RangeCoordUtils" {
|
|
|
14137
14137
|
* Additional this takes an onVisit callback.
|
|
14138
14138
|
*/
|
|
14139
14139
|
export const build2DArray: <T>(values: T[], width: number, onVisit?: (val: T) => T) => T[][];
|
|
14140
|
-
export const removeRangesWithOffsets: (ranges:
|
|
14140
|
+
export const removeRangesWithOffsets: (ranges: IRange.Coords[], set: Set<number>) => IRange.Coords[];
|
|
14141
14141
|
/**
|
|
14142
14142
|
* Returns true if the outer span intersects the inner span.
|
|
14143
14143
|
* @remarks
|
|
@@ -14153,7 +14153,7 @@ declare module "utils/_RangeCoordUtils" {
|
|
|
14153
14153
|
/**
|
|
14154
14154
|
* Returns true if the range intersections in an orientation.
|
|
14155
14155
|
*/
|
|
14156
|
-
export const isSplitRangeSpan: (outerRange:
|
|
14156
|
+
export const isSplitRangeSpan: (outerRange: IRange.Coords, innerRange: IRange.Coords, isColumn: boolean) => boolean;
|
|
14157
14157
|
/**
|
|
14158
14158
|
* Subtract Range b from from a.
|
|
14159
14159
|
*
|
|
@@ -14166,27 +14166,27 @@ declare module "utils/_RangeCoordUtils" {
|
|
|
14166
14166
|
* * If no interaction then b will be returned.
|
|
14167
14167
|
* * If beforeSplit === rangeToRemove then empty array is returned.
|
|
14168
14168
|
*/
|
|
14169
|
-
export const subtractRange: (beforeSplit:
|
|
14169
|
+
export const subtractRange: (beforeSplit: IRange.Coords, rangeToRemove: IRange.Coords, orientation?: IRange.Orientation) => IRange.Coords[];
|
|
14170
14170
|
/**
|
|
14171
14171
|
* Visit ranges looking to see if range intersects. If so then onOverlap will be called.
|
|
14172
14172
|
* @param range
|
|
14173
14173
|
* @param ranges
|
|
14174
14174
|
* @param onOverlap
|
|
14175
14175
|
*/
|
|
14176
|
-
export const visitRangeIntersects: (ranges:
|
|
14176
|
+
export const visitRangeIntersects: (ranges: IRange.Coords[], range: IRange.Coords, onOverlap: (range: IRange.Coords, isSplit: boolean, index: number) => void) => void;
|
|
14177
14177
|
/**
|
|
14178
14178
|
* Returns a CellCoords that is the top left.
|
|
14179
14179
|
* @param range A RangeCoord to check.
|
|
14180
14180
|
*/
|
|
14181
|
-
export const topLeft: (range:
|
|
14182
|
-
export const createColOffsetComparator: (aRange:
|
|
14183
|
-
export const createRowOffsetComparator: (aRange:
|
|
14181
|
+
export const topLeft: (range: IRange.Coords | undefined) => IRange.CellCoords;
|
|
14182
|
+
export const createColOffsetComparator: (aRange: IRange.Coords, bRange: IRange.Coords) => ((a: IRange.CellCoords, b: IRange.CellCoords) => number);
|
|
14183
|
+
export const createRowOffsetComparator: (aRange: IRange.Coords, bRange: IRange.Coords) => ((a: IRange.CellCoords, b: IRange.CellCoords) => number);
|
|
14184
14184
|
/**
|
|
14185
14185
|
* Determines the copy coordinates trying to find the lcm.
|
|
14186
14186
|
*/
|
|
14187
|
-
export const coordsLCM: (dest:
|
|
14188
|
-
size:
|
|
14189
|
-
fit?: boolean, transpose?: boolean) =>
|
|
14187
|
+
export const coordsLCM: (dest: IRange.Coords, // destination (for top,left)
|
|
14188
|
+
size: IRange.Coords, // source (for sizing)
|
|
14189
|
+
fit?: boolean, transpose?: boolean) => IRange.Coords;
|
|
14190
14190
|
}
|
|
14191
14191
|
declare module "collections/RepeatingList" {
|
|
14192
14192
|
import { IList, IListLike } from "collections/IList";
|
|
@@ -15093,8 +15093,7 @@ declare module "workbook/IWorkbook" {
|
|
|
15093
15093
|
/**
|
|
15094
15094
|
* Search the entire Workbook.
|
|
15095
15095
|
*
|
|
15096
|
-
* @param
|
|
15097
|
-
* @param options {@link ICellRange.FindOptions}
|
|
15096
|
+
* @param options The text to search for or {@link ICellRange.FindOptions}
|
|
15098
15097
|
*
|
|
15099
15098
|
* @remarks
|
|
15100
15099
|
* Searches all sheets.
|
|
@@ -15102,7 +15101,7 @@ declare module "workbook/IWorkbook" {
|
|
|
15102
15101
|
* @see
|
|
15103
15102
|
* {@link ICellRange.find}
|
|
15104
15103
|
*/
|
|
15105
|
-
find(
|
|
15104
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
15106
15105
|
/**
|
|
15107
15106
|
* Replace all items in the iterator
|
|
15108
15107
|
*
|
|
@@ -15133,6 +15132,7 @@ declare module "workbook/IWorkbook" {
|
|
|
15133
15132
|
findValidSheetName(sheetName: string): string;
|
|
15134
15133
|
/**
|
|
15135
15134
|
* Indicate if the current character is a valid character for a sheetName.
|
|
15135
|
+
*
|
|
15136
15136
|
* @param character The string to validate.
|
|
15137
15137
|
*/
|
|
15138
15138
|
isValidSheetNameCharacter(character: string): boolean;
|
|
@@ -15176,6 +15176,7 @@ declare module "workbook/IWorkbook" {
|
|
|
15176
15176
|
setTheme(theme: ITheme | null): ITheme;
|
|
15177
15177
|
/**
|
|
15178
15178
|
* Is date resolution 1904 instead of 1900 based.
|
|
15179
|
+
*
|
|
15179
15180
|
* @see
|
|
15180
15181
|
* {@link https://support.microsoft.com/en-us/office/date-systems-in-excel-e7fe7167-48a9-4b96-bb53-5612a800b487}
|
|
15181
15182
|
*/
|
|
@@ -15217,9 +15218,9 @@ declare module "workbook/IWorkbook" {
|
|
|
15217
15218
|
/**
|
|
15218
15219
|
* Serialize the workbook to a JSON.
|
|
15219
15220
|
*
|
|
15220
|
-
* @param
|
|
15221
|
+
* @param ignoreData If `true` only meta data about the workbook will be saved.
|
|
15221
15222
|
*/
|
|
15222
|
-
toJSON(
|
|
15223
|
+
toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
|
|
15223
15224
|
/**
|
|
15224
15225
|
* Returns any custom workbook options that are provided in constructor.
|
|
15225
15226
|
*/
|
|
@@ -16183,7 +16184,7 @@ declare module "sheet/_SheetMessages" {
|
|
|
16183
16184
|
export const MODEL_CLOSED = "Sheet has been closed. No further operations are allowed.";
|
|
16184
16185
|
export const ERROR_MODEL_DELETE = "Unable to delete.";
|
|
16185
16186
|
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
|
|
16187
|
+
export const ERROR_ITERATOR_NO_CELL_CONTEXT = "IteratorContext can only return a cell if the forEach ignoreCellDetails has not been set to false.";
|
|
16187
16188
|
export const ERROR_INTERNAL_LISTENER_READ_ONLY = "To write the listener must be registered with the wrTable.IListener option.";
|
|
16188
16189
|
export const ERROR_ADDRESS_INVALID_SCOPE = "When using addresses directly from the sheet do not include the sheet name.";
|
|
16189
16190
|
export const ERROR_MAX_VALUES: (max: number) => string;
|
|
@@ -16584,7 +16585,7 @@ declare module "autoFill/IAutoFill" {
|
|
|
16584
16585
|
}
|
|
16585
16586
|
}
|
|
16586
16587
|
declare module "text/TextFrame" {
|
|
16587
|
-
import {
|
|
16588
|
+
import { type Size, type Bounds, type Rectangle } from '@sheetxl/utils';
|
|
16588
16589
|
import { TextVisitor } from "text/TextVisitor";
|
|
16589
16590
|
import { ITextLine } from "text/TextLine";
|
|
16590
16591
|
import { ITextParagraph } from "text/TextParagraph";
|
|
@@ -16596,14 +16597,14 @@ declare module "text/TextFrame" {
|
|
|
16596
16597
|
private _bounds;
|
|
16597
16598
|
private _textBounds;
|
|
16598
16599
|
private _lines;
|
|
16599
|
-
private
|
|
16600
|
+
private _lastLayoutSize;
|
|
16600
16601
|
private _lastLayout;
|
|
16601
16602
|
private _defaultFont;
|
|
16602
16603
|
private _alignment;
|
|
16603
16604
|
constructor(overrides: Partial<ITextFrame>, defaultFont: IStyledFont, alignment: ITextBoxAlignment, lines?: ITextLine[], bounds?: Bounds, textBounds?: Bounds);
|
|
16604
16605
|
visitParas(visitor: TextVisitor): void;
|
|
16605
16606
|
visitLines(visitor: TextVisitor): void;
|
|
16606
|
-
layout(
|
|
16607
|
+
layout(size?: Partial<Size>): ITextFrame;
|
|
16607
16608
|
clone(visitor?: TextVisitor): ITextFrame;
|
|
16608
16609
|
equals(other: ITextParagraph): boolean;
|
|
16609
16610
|
/** {@inheritDoc ITextFrame.createTemporaryTextFrame} */
|
|
@@ -16707,7 +16708,7 @@ declare module "text/TextWrapper" {
|
|
|
16707
16708
|
}
|
|
16708
16709
|
}
|
|
16709
16710
|
declare module "text/_TextUtils" {
|
|
16710
|
-
import {
|
|
16711
|
+
import { type Size } from '@sheetxl/utils';
|
|
16711
16712
|
import { IFont } from "font/index";
|
|
16712
16713
|
import { ITextFrame } from "text/ITextFrame";
|
|
16713
16714
|
import { ITextBoxAlignment } from "text/TextBoxAlignment";
|
|
@@ -16720,7 +16721,7 @@ declare module "text/_TextUtils" {
|
|
|
16720
16721
|
* @param dimensions
|
|
16721
16722
|
* @param textMeasurer This defaults to a canvas context
|
|
16722
16723
|
*/
|
|
16723
|
-
export const layoutTextFrame: (textFrame: ITextFrame, defaultFont: IStyledFont, alignment: ITextBoxAlignment, dimensions?: Partial<
|
|
16724
|
+
export const layoutTextFrame: (textFrame: ITextFrame, defaultFont: IStyledFont, alignment: ITextBoxAlignment, dimensions?: Partial<Size>, textMeasurer?: IFont.Measurer) => ITextFrame;
|
|
16724
16725
|
/**
|
|
16725
16726
|
* Checks whether a string is entirely uppercase, lowercase, or mixed case.
|
|
16726
16727
|
*
|
|
@@ -17055,7 +17056,7 @@ declare module "movable/IMovableCollection" {
|
|
|
17055
17056
|
* Indicate if items that are in hidden headers or marked as hidden should be returned.
|
|
17056
17057
|
* @defaultValue false
|
|
17057
17058
|
*/
|
|
17058
|
-
|
|
17059
|
+
ignoreHidden?: boolean;
|
|
17059
17060
|
/**
|
|
17060
17061
|
* The type to search for. If not provided all items will be returned.
|
|
17061
17062
|
*/
|
|
@@ -17440,7 +17441,7 @@ declare module "movable/MovableCollection" {
|
|
|
17440
17441
|
}
|
|
17441
17442
|
}
|
|
17442
17443
|
declare module "picture/IPicture" {
|
|
17443
|
-
import type {
|
|
17444
|
+
import type { Size } from '@sheetxl/utils';
|
|
17444
17445
|
import type { IListener } from "listener/index";
|
|
17445
17446
|
import type { IResource } from "resource/index";
|
|
17446
17447
|
import type { IModel } from "model/index";
|
|
@@ -17486,7 +17487,7 @@ declare module "picture/IPicture" {
|
|
|
17486
17487
|
/**
|
|
17487
17488
|
* The size of the image without any constraints. This info is determined by the file.
|
|
17488
17489
|
*/
|
|
17489
|
-
|
|
17490
|
+
getNaturalSize(): Size;
|
|
17490
17491
|
/**
|
|
17491
17492
|
* As a url that can be attached to the dom.
|
|
17492
17493
|
*/
|
|
@@ -18343,7 +18344,7 @@ declare module "conditional/IConditionalFormatCollection" {
|
|
|
18343
18344
|
*
|
|
18344
18345
|
* @defaultValue false
|
|
18345
18346
|
*/
|
|
18346
|
-
|
|
18347
|
+
ignoreHidden?: boolean;
|
|
18347
18348
|
/**
|
|
18348
18349
|
* Only return items that are completely contained with the search bounds.
|
|
18349
18350
|
*
|
|
@@ -18838,7 +18839,7 @@ declare module "table/TableCollection" {
|
|
|
18838
18839
|
private _add;
|
|
18839
18840
|
private _get;
|
|
18840
18841
|
private _getByName;
|
|
18841
|
-
constructor(add: (address: ICellRange.Address, options: ITableCollection.AddOptions) => ITable, get: (address: ICellRanges.Address,
|
|
18842
|
+
constructor(add: (address: ICellRange.Address, options: ITableCollection.AddOptions) => ITable, get: (address: ICellRanges.Address, ignoreHidden: boolean, fullyContained: boolean) => ITable[], getByName: (name: string) => ITable);
|
|
18842
18843
|
/** {@inheritDoc ITableCollection.add} */
|
|
18843
18844
|
add(address: ICellRange.Address, options?: ITableCollection.AddOptions): ITable;
|
|
18844
18845
|
/** {@inheritDoc ITableCollection.getItems} */
|
|
@@ -19215,7 +19216,7 @@ declare module "conditional/ConditionalFormatCollection" {
|
|
|
19215
19216
|
export class ConditionalFormatCollection implements IConditionalFormatCollection {
|
|
19216
19217
|
private _add;
|
|
19217
19218
|
private _get;
|
|
19218
|
-
constructor(add: (address: ICellRange.Address, options: IConditionalFormatCollection.AddOptions) => IConditionalFormat, get: (address: ICellRanges.Address,
|
|
19219
|
+
constructor(add: (address: ICellRange.Address, options: IConditionalFormatCollection.AddOptions) => IConditionalFormat, get: (address: ICellRanges.Address, ignoreHidden: boolean, fullyContained: boolean) => IConditionalFormat[]);
|
|
19219
19220
|
/** {@inheritDoc IConditionalFormatCollection.add} */
|
|
19220
19221
|
add(address: ICellRange.Address, options?: IConditionalFormatCollection.AddOptions): IConditionalFormat;
|
|
19221
19222
|
/** {@inheritDoc IConditionalFormatCollection.getItems} */
|
|
@@ -19378,7 +19379,7 @@ declare module "sheet/protection/index" {
|
|
|
19378
19379
|
export * from "sheet/protection/ISheetProtection";
|
|
19379
19380
|
}
|
|
19380
19381
|
declare module "utils/GeomUtils" {
|
|
19381
|
-
import { Point,
|
|
19382
|
+
import type { Point, Size, Bounds } from '@sheetxl/utils';
|
|
19382
19383
|
/**
|
|
19383
19384
|
* Return the union of to 2 bounds.
|
|
19384
19385
|
* @remarks
|
|
@@ -19412,7 +19413,7 @@ declare module "utils/GeomUtils" {
|
|
|
19412
19413
|
* Takes an an inner un-rotated dimension and an outer un-rotated dimension and then will return
|
|
19413
19414
|
* an un-rotated rectangle that if rotated will fit inside the outer rectangle.
|
|
19414
19415
|
*/
|
|
19415
|
-
export const clipToOuterRect: (dimInner:
|
|
19416
|
+
export const clipToOuterRect: (dimInner: Size, dimOuter: Size, rotation?: number) => Size;
|
|
19416
19417
|
export const findIntersectMath: (p1: Point, p2: Point, min: number, max: number) => {
|
|
19417
19418
|
min: number;
|
|
19418
19419
|
max: number;
|
|
@@ -19539,7 +19540,7 @@ declare module "sheet/clipboard/_ClipboardUtils" {
|
|
|
19539
19540
|
*/
|
|
19540
19541
|
export const parseAsTable: (htmlDoc: Document, plainTextArray: string[][], parser: IHTMLParser.TableParser) => boolean;
|
|
19541
19542
|
}
|
|
19542
|
-
declare module "utils/
|
|
19543
|
+
declare module "utils/_CSSUtils" {
|
|
19543
19544
|
import { TextDecoration as CSSTextDecoration } from 'csstype';
|
|
19544
19545
|
import { Bounds } from '@sheetxl/utils';
|
|
19545
19546
|
import { IColor } from "color/index";
|
|
@@ -19840,7 +19841,7 @@ declare module "sheet/header/_HeaderUtils" {
|
|
|
19840
19841
|
export const createRunsFromSelection: (header: ISheetHeader, selection: IRangeSelection.Coords, maxRange: IRange.Coords) => ITypes.RunCoordValue<ISheetHeader.SelectedRun>[];
|
|
19841
19842
|
}
|
|
19842
19843
|
declare module "sheet/header/SheetCellHeader" {
|
|
19843
|
-
import {
|
|
19844
|
+
import { IRange } from '@sheetxl/primitives';
|
|
19844
19845
|
import { IStyle, IStyleCollection } from "style/index";
|
|
19845
19846
|
import { ICell, ICellHeader } from "cell/index";
|
|
19846
19847
|
import { ISheetHeader } from "sheet/header/ISheetHeader";
|
|
@@ -19871,7 +19872,7 @@ declare module "sheet/header/SheetCellHeader" {
|
|
|
19871
19872
|
/** {@inheritDoc ICellHeader.getDisplayText} */
|
|
19872
19873
|
getDisplayText(): string;
|
|
19873
19874
|
/** {@inheritDoc ICellHeader.getOrientation} */
|
|
19874
|
-
getOrientation():
|
|
19875
|
+
getOrientation(): IRange.Orientation;
|
|
19875
19876
|
/** {@inheritDoc ICellHeader.isHidden} */
|
|
19876
19877
|
isHidden(): boolean;
|
|
19877
19878
|
/** {@inheritDoc ICellHeader.isCustomSize} */
|
|
@@ -19964,7 +19965,7 @@ declare module "sheet/header/SheetHeader" {
|
|
|
19964
19965
|
constructor(options: SheetHeader.ConstructorOptions);
|
|
19965
19966
|
/** {@inheritDoc IListener.ISource.addListeners} */
|
|
19966
19967
|
addListeners(listeners: ISheetHeader.IListeners, options?: IListener.Options): IListener.Remove;
|
|
19967
|
-
protected _invalidSizes(): void;
|
|
19968
|
+
protected _invalidSizes(force?: boolean): void;
|
|
19968
19969
|
protected _onHeaderChange(): void;
|
|
19969
19970
|
/** {@inheritDoc ISheetHeader.getSheet} */
|
|
19970
19971
|
getSheet(): ISheet;
|
|
@@ -20254,7 +20255,7 @@ declare module "fill/_BuiltInPatterns" {
|
|
|
20254
20255
|
declare module "sheet/style/SheetCellStyle" {
|
|
20255
20256
|
import { Properties as CSSProperties } from 'csstype';
|
|
20256
20257
|
import { IRange } from '@sheetxl/primitives';
|
|
20257
|
-
import {
|
|
20258
|
+
import { type Size, type Rectangle, type Bounds } from '@sheetxl/utils';
|
|
20258
20259
|
import { IProperties } from "type/index";
|
|
20259
20260
|
import { IColor } from "color/index";
|
|
20260
20261
|
import { IFill } from "fill/index";
|
|
@@ -20420,7 +20421,7 @@ declare module "sheet/style/SheetCellStyle" {
|
|
|
20420
20421
|
export class CellFont extends Inheritable<IStyledFont.Properties, IStyledFont.JSON> implements IStyledFont {
|
|
20421
20422
|
isEqualMeasure(other: IStyledFont): boolean;
|
|
20422
20423
|
/** {@inheritDoc IStyle.toCSS} */
|
|
20423
|
-
toCSS(darkMode?: boolean, zoom?: number,
|
|
20424
|
+
toCSS(darkMode?: boolean, zoom?: number, ignoreNormal?: boolean): CSSProperties;
|
|
20424
20425
|
/** {@inheritDoc IStyle.isSuperSub} */
|
|
20425
20426
|
isSuperSub(): boolean;
|
|
20426
20427
|
/** {@inheritDoc IStyle.isSuperSub} */
|
|
@@ -20572,7 +20573,7 @@ declare module "sheet/style/SheetCellStyle" {
|
|
|
20572
20573
|
export class SheetCellStyle implements IStyle {
|
|
20573
20574
|
protected _o: CreateCellStyleOptions;
|
|
20574
20575
|
protected _p: InheritableProperties<IStyle.Properties, IStyle.JSON>;
|
|
20575
|
-
protected _bestFit: Partial<
|
|
20576
|
+
protected _bestFit: Partial<Size>;
|
|
20576
20577
|
protected _insets: Rectangle;
|
|
20577
20578
|
protected _hasVisibleStyling: boolean;
|
|
20578
20579
|
constructor(options: CreateCellStyleOptions);
|
|
@@ -20591,7 +20592,7 @@ declare module "sheet/style/SheetCellStyle" {
|
|
|
20591
20592
|
/** {@inheritDoc IStyle.update} */
|
|
20592
20593
|
update(update: IStyle.Update, options?: IStyle.UpdateOptions): IStyle;
|
|
20593
20594
|
/** {@inheritDoc IStyle.getBestFit} */
|
|
20594
|
-
getBestFit(): Partial<
|
|
20595
|
+
getBestFit(): Partial<Size> | null;
|
|
20595
20596
|
/** {@inheritDoc IStyle.getInsets} */
|
|
20596
20597
|
getInsets(): Rectangle;
|
|
20597
20598
|
/** {@inheritDoc IStyle.getBorder} */
|
|
@@ -20915,7 +20916,7 @@ declare module "calculation/spatial/index" {
|
|
|
20915
20916
|
}
|
|
20916
20917
|
declare module "sheet/_SheetTypes" {
|
|
20917
20918
|
import { ScalarType, Scalar, IRange } from '@sheetxl/primitives';
|
|
20918
|
-
import type {
|
|
20919
|
+
import type { Size, Rectangle } from '@sheetxl/utils';
|
|
20919
20920
|
import { IProperties } from "type/index";
|
|
20920
20921
|
import { NumberFormat } from "numFmt/index";
|
|
20921
20922
|
import type { ITextFrame } from "text/index";
|
|
@@ -20967,7 +20968,7 @@ declare module "sheet/_SheetTypes" {
|
|
|
20967
20968
|
* @cacheValue
|
|
20968
20969
|
*/
|
|
20969
20970
|
i?: Readonly<Rectangle>;
|
|
20970
|
-
o?: Readonly<Partial<
|
|
20971
|
+
o?: Readonly<Partial<Size>> | null;
|
|
20971
20972
|
w?: readonly string[] | null;
|
|
20972
20973
|
B?: any;
|
|
20973
20974
|
b?: any;
|
|
@@ -21051,7 +21052,7 @@ declare module "sheet/_SheetTypes" {
|
|
|
21051
21052
|
interface IteratorOptions extends OverlappingRange.IteratorOptions {
|
|
21052
21053
|
includeRangeTypes: boolean | SearchTypes;
|
|
21053
21054
|
bounds?: IRange.Coords;
|
|
21054
|
-
|
|
21055
|
+
ignoreHidden?: boolean | IRange.Orientation;
|
|
21055
21056
|
includeMergeOverflow?: boolean;
|
|
21056
21057
|
}
|
|
21057
21058
|
interface Entry {
|
|
@@ -21421,7 +21422,7 @@ declare module "numFmt/_FormatCell" {
|
|
|
21421
21422
|
}
|
|
21422
21423
|
declare module "sheet/SheetCell" {
|
|
21423
21424
|
import { Scalar, ScalarType, IRange, FormulaError } from '@sheetxl/primitives';
|
|
21424
|
-
import {
|
|
21425
|
+
import { type Size, type Rectangle } from '@sheetxl/utils';
|
|
21425
21426
|
import { IProperties, ITypes } from "type/index";
|
|
21426
21427
|
import { NumberFormat } from "numFmt/index";
|
|
21427
21428
|
import { ITextFrame } from "text/index";
|
|
@@ -21480,7 +21481,7 @@ declare module "sheet/SheetCell" {
|
|
|
21480
21481
|
/** Guaranteed to never return null */
|
|
21481
21482
|
export const csStyle: (specific: boolean, range: IRange.Coords, intersection: RangeState.Intersection, options: SheetCellOptions) => IStyle;
|
|
21482
21483
|
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<
|
|
21484
|
+
customHash?: string, cache?: Cache<string, Readonly<Partial<Size>>>) => Readonly<Partial<Size>>;
|
|
21484
21485
|
export interface SheetCellOptions {
|
|
21485
21486
|
resolveRange: (address?: ICellRange.Address) => ICellRange | null;
|
|
21486
21487
|
sheet: ISheet;
|
|
@@ -21540,7 +21541,7 @@ declare module "sheet/SheetCell" {
|
|
|
21540
21541
|
/** {@inheritDoc ICell.isContentful} */
|
|
21541
21542
|
isContentful(): boolean;
|
|
21542
21543
|
/** {@inheritDoc ICell.getBestFit} */
|
|
21543
|
-
getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<
|
|
21544
|
+
getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
|
|
21544
21545
|
/** {@inheritDoc ICell.getInsets} */
|
|
21545
21546
|
getInsets(): Rectangle;
|
|
21546
21547
|
/** {@inheritDoc ICell.getTextFrame} */
|
|
@@ -21565,7 +21566,7 @@ declare module "sheet/SheetCell" {
|
|
|
21565
21566
|
/** {@inheritDoc ICell.toDate} */
|
|
21566
21567
|
toDate(): Date | null;
|
|
21567
21568
|
/** {@inheritDoc ICell.toText} */
|
|
21568
|
-
toText(
|
|
21569
|
+
toText(): string;
|
|
21569
21570
|
/** {@inheritDoc ICell.toTextUnformatted} */
|
|
21570
21571
|
toTextUnformatted(showFormula?: boolean): string;
|
|
21571
21572
|
/** {@inheritDoc ICell.getComments} */
|
|
@@ -21577,7 +21578,7 @@ declare module "sheet/SheetCell" {
|
|
|
21577
21578
|
/** {@inheritDoc ICell.getWarnings} */
|
|
21578
21579
|
getWarnings(): readonly string[];
|
|
21579
21580
|
/** {@inheritDoc ICell.getSpans} */
|
|
21580
|
-
getSpans(): Readonly<
|
|
21581
|
+
getSpans(): Readonly<Size>;
|
|
21581
21582
|
/** {@inheritDoc ICell.isTopLeft} */
|
|
21582
21583
|
isTopLeft(): boolean;
|
|
21583
21584
|
/** {@inheritDoc ICell.getSpill} */
|
|
@@ -21640,7 +21641,7 @@ declare module "sheet/SheetRanges" {
|
|
|
21640
21641
|
import type { IStyle } from "style/index";
|
|
21641
21642
|
import type { ISheet } from "sheet/index";
|
|
21642
21643
|
export interface SheetRangesOptions {
|
|
21643
|
-
|
|
21644
|
+
ignoreHidden?: boolean;
|
|
21644
21645
|
readOnly?: string;
|
|
21645
21646
|
getOptions: ICellRange.GetRangeOptions;
|
|
21646
21647
|
}
|
|
@@ -21668,7 +21669,7 @@ declare module "sheet/SheetRanges" {
|
|
|
21668
21669
|
/** {@inheritDoc ICellRanges.addListener} */
|
|
21669
21670
|
addListener(listener: ICellRange.Listener, options?: ICellRange.ListenerOptions): IListener.Remove;
|
|
21670
21671
|
/** {@inheritDoc ICellRanges.find} */
|
|
21671
|
-
find(
|
|
21672
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
21672
21673
|
/** {@inheritDoc ICellRanges.getFlattened} */
|
|
21673
21674
|
getFlattened(options?: ICellRange.GetFlattenOptions): this;
|
|
21674
21675
|
/** {@inheritDoc ICellRanges.getVisible} */
|
|
@@ -21682,15 +21683,15 @@ declare module "sheet/SheetRanges" {
|
|
|
21682
21683
|
/** {@inheritDoc ICellRanges.getStyle} */
|
|
21683
21684
|
getStyle(): IStyle;
|
|
21684
21685
|
/** {@inheritDoc ICellRanges.merge} */
|
|
21685
|
-
merge(options?:
|
|
21686
|
+
merge(options?: IRange.Orientations | ICellRange.MergeOptions): this;
|
|
21686
21687
|
/** {@inheritDoc ICellRanges.unmerge} */
|
|
21687
21688
|
unmerge(options?: ITransaction.OperationOptions): this;
|
|
21688
21689
|
/** {@inheritDoc ICellRanges.getMerges} */
|
|
21689
21690
|
getMerges(): IRange.Coords[];
|
|
21690
21691
|
/** {@inheritDoc ICellRanges.insert} */
|
|
21691
|
-
insert(
|
|
21692
|
+
insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
|
|
21692
21693
|
/** {@inheritDoc ICellRanges.delete} */
|
|
21693
|
-
delete(
|
|
21694
|
+
delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
|
|
21694
21695
|
/** {@inheritDoc ICellRanges.insertFrom} */
|
|
21695
21696
|
insertFrom(source: ICellRange.Address | ICellRange.ISnapshot, options?: ICellRange.InsertFromOptions): Promise<this | null>;
|
|
21696
21697
|
/** {@inheritDoc ICellRanges.copyFrom} */
|
|
@@ -21780,7 +21781,7 @@ declare module "calculation/graph/_CalcGraphUtils" {
|
|
|
21780
21781
|
}
|
|
21781
21782
|
declare module "sheet/Sheet" {
|
|
21782
21783
|
import { Scalar, JSScalar, IRange } from '@sheetxl/primitives';
|
|
21783
|
-
import {
|
|
21784
|
+
import { Size, type Bounds, CoordUtils } from '@sheetxl/utils';
|
|
21784
21785
|
import { ITypes, ICollection, IProperties } from "type/index";
|
|
21785
21786
|
import type { IWorkbook } from "workbook/index";
|
|
21786
21787
|
import type { IListener } from "listener/index";
|
|
@@ -21899,7 +21900,7 @@ declare module "sheet/Sheet" {
|
|
|
21899
21900
|
options: ICellRange.ListenerOptions;
|
|
21900
21901
|
}
|
|
21901
21902
|
interface GetRangeEntriesOptions<T = any, E = any> {
|
|
21902
|
-
|
|
21903
|
+
ignoreHidden?: boolean | IRange.Orientation;
|
|
21903
21904
|
fullyContained?: boolean;
|
|
21904
21905
|
onEntry?: (value: E, entry: ISpatialMap.Entry<T>) => T | void;
|
|
21905
21906
|
noCache?: boolean;
|
|
@@ -22025,7 +22026,7 @@ declare module "sheet/Sheet" {
|
|
|
22025
22026
|
};
|
|
22026
22027
|
protected _lastGetRangeRead: Record<string, {
|
|
22027
22028
|
ranges: readonly IRange.Coords[];
|
|
22028
|
-
|
|
22029
|
+
ignoreHidden: boolean | IRange.Orientation;
|
|
22029
22030
|
results: any[];
|
|
22030
22031
|
}>;
|
|
22031
22032
|
protected _lastUsedCoordsRead: {
|
|
@@ -22068,7 +22069,7 @@ declare module "sheet/Sheet" {
|
|
|
22068
22069
|
protected _closed: boolean;
|
|
22069
22070
|
protected _defaultColWidthCache: number;
|
|
22070
22071
|
protected _defaultRowHeightCache: number;
|
|
22071
|
-
protected _defaultFontBoundsCache: Readonly<
|
|
22072
|
+
protected _defaultFontBoundsCache: Readonly<Size>;
|
|
22072
22073
|
constructor(options?: ISheet.ConstructorOptions);
|
|
22073
22074
|
/** @internal */
|
|
22074
22075
|
protected _createRange(coords: Readonly<IRange.FixableCoords>, getOptions?: ICellRange.GetRangeOptions, readOnly?: string): ICellRange;
|
|
@@ -22189,7 +22190,7 @@ declare module "sheet/Sheet" {
|
|
|
22189
22190
|
/** @internal */
|
|
22190
22191
|
protected _unmerge(ranges: readonly IRange.Coords[], options?: ITransaction.OperationOptions): void;
|
|
22191
22192
|
/** @internal */
|
|
22192
|
-
protected _getMerges(ranges: readonly IRange.Coords[],
|
|
22193
|
+
protected _getMerges(ranges: readonly IRange.Coords[], ignoreHidden?: boolean | IRange.Orientation): IRange.Coords[];
|
|
22193
22194
|
/** @internal */
|
|
22194
22195
|
protected _clone(): ISheet;
|
|
22195
22196
|
/** @internal */
|
|
@@ -22223,9 +22224,9 @@ declare module "sheet/Sheet" {
|
|
|
22223
22224
|
/** @internal */
|
|
22224
22225
|
protected _insertFrom(ranges: readonly IRange.Coords[], source: ICellRange.Address | ICellRange.ISnapshot, options?: ICellRange.InsertFromOptions): Promise<IRange.Coords>;
|
|
22225
22226
|
/** @internal */
|
|
22226
|
-
protected _insertCells(ranges: readonly IRange.Coords[],
|
|
22227
|
+
protected _insertCells(ranges: readonly IRange.Coords[], options?: IRange.Orientation | ICellRange.InsertOptions, coordValidator?: CoordUtils.CoordValidator): void;
|
|
22227
22228
|
/** @internal */
|
|
22228
|
-
protected _deleteCells(ranges: readonly IRange.Coords[],
|
|
22229
|
+
protected _deleteCells(ranges: readonly IRange.Coords[], options?: IRange.Orientation | ICellRange.DeleteOptions): void;
|
|
22229
22230
|
/**
|
|
22230
22231
|
* Automatically adjusts row heights and column widths to fit cell content and styles.
|
|
22231
22232
|
* - Merges and sorts input ranges for efficient processing.
|
|
@@ -22271,17 +22272,17 @@ declare module "sheet/Sheet" {
|
|
|
22271
22272
|
/** @internal */
|
|
22272
22273
|
protected _getUsedCoords(_options?: ICellRange.GetRangeOptions): IRange.Coords | null;
|
|
22273
22274
|
/** @internal */
|
|
22274
|
-
protected _isContentful(ranges: readonly IRange.Coords[],
|
|
22275
|
+
protected _isContentful(ranges: readonly IRange.Coords[], ignoreHidden?: boolean | IRange.Orientation): boolean;
|
|
22275
22276
|
/** @internal */
|
|
22276
|
-
protected _getCount(coords: IRange.Coords[],
|
|
22277
|
+
protected _getCount(coords: IRange.Coords[], ignoreHidden?: boolean): number;
|
|
22277
22278
|
/** @internal */
|
|
22278
|
-
protected _contentCounts(ranges: readonly IRange.Coords[], types: ICell.Content[],
|
|
22279
|
+
protected _contentCounts(ranges: readonly IRange.Coords[], types: ICell.Content[], ignoreHidden: boolean | IRange.Orientation): ICellRange.Counts;
|
|
22279
22280
|
/** {@inheritDoc ISheet.getSelectedCell} */
|
|
22280
22281
|
getSelectedCell(): ICell;
|
|
22281
22282
|
/** {@inheritDoc ISheet.find} */
|
|
22282
|
-
find(
|
|
22283
|
+
find(options?: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22283
22284
|
/** @internal */
|
|
22284
|
-
protected _find(ranges: readonly IRange.Coords[],
|
|
22285
|
+
protected _find(ranges: readonly IRange.Coords[], options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22285
22286
|
/** {@inheritDoc ISheet.isDate1904} */
|
|
22286
22287
|
isDate1904(): boolean;
|
|
22287
22288
|
/** @internal */
|
|
@@ -22289,11 +22290,11 @@ declare module "sheet/Sheet" {
|
|
|
22289
22290
|
/** @internal */
|
|
22290
22291
|
protected _extendRange(direction: IRange.Direction, coords: IRange.CellCoords): Readonly<IRange.Coords>;
|
|
22291
22292
|
/** @internal */
|
|
22292
|
-
protected _defaultFontDims(): Readonly<
|
|
22293
|
+
protected _defaultFontDims(): Readonly<Size>;
|
|
22293
22294
|
/** {@inheritDoc ISheet.getColumnWidthAsFontUnit} */
|
|
22294
22295
|
getColumnWidthAsFontUnit(pixelWidth: number): number;
|
|
22295
22296
|
/**
|
|
22296
|
-
* col width in
|
|
22297
|
+
* col width in character units
|
|
22297
22298
|
* @internal
|
|
22298
22299
|
*/
|
|
22299
22300
|
protected _defaultColWidth(): number;
|
|
@@ -22305,13 +22306,15 @@ declare module "sheet/Sheet" {
|
|
|
22305
22306
|
/** {@inheritDoc ISheet.getProtection} */
|
|
22306
22307
|
getProtection(): ISheetProtection;
|
|
22307
22308
|
/** @internal */
|
|
22308
|
-
protected _selectSheet(coords: IRange.Coords, scrollIntoView?:
|
|
22309
|
+
protected _selectSheet(coords: IRange.Coords, scrollIntoView?: boolean | ICellRange.ScrollIntoViewOptions): Promise<boolean>;
|
|
22309
22310
|
/** {@inheritDoc ISheet.scrollTo} */
|
|
22310
22311
|
scrollTo(coords: Partial<IRange.Coords>, options?: ISheet.ScrollToOptions): Promise<boolean>;
|
|
22311
22312
|
/** @internal */
|
|
22312
|
-
protected
|
|
22313
|
+
protected _resolveSelectOptions(selectOptions: boolean | ICellRange.SelectOptions, orientation: IRange.Orientation): ICellRange.SelectOptions;
|
|
22314
|
+
/** @internal */
|
|
22315
|
+
protected _commitAndAutoSelect(trans: ITransaction, selection: Partial<IRangeSelection.Coords>, selectOptions?: boolean | ICellRange.SelectOptions, commitOptions?: ITransaction.StoreOperationOptions<CommitView>, orientation?: IRange.Orientation): Promise<IRange.Coords[]>;
|
|
22313
22316
|
/** @internal */
|
|
22314
|
-
protected _autoSelect(options?: boolean | ICellRange.SelectOptions, selection?: Partial<IRangeSelection.Coords
|
|
22317
|
+
protected _autoSelect(options?: boolean | ICellRange.SelectOptions, selection?: Partial<IRangeSelection.Coords>, orientation?: IRange.Orientation): Promise<IRange.Coords[]>;
|
|
22315
22318
|
/** {@inheritDoc ISheet.getSelection} */
|
|
22316
22319
|
getSelection(): IRangeSelection;
|
|
22317
22320
|
/** {@inheritDoc ISheet.getView} */
|
|
@@ -22327,7 +22330,7 @@ declare module "sheet/Sheet" {
|
|
|
22327
22330
|
/** {@inheritDoc ISheet.getColumnHeaders} */
|
|
22328
22331
|
getColumnHeaders(): ISheetHeader;
|
|
22329
22332
|
/** {@inheritDoc ISheet.toJSON} */
|
|
22330
|
-
toJSON(
|
|
22333
|
+
toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
|
|
22331
22334
|
/** {@inheritDoc ISheet.getStyles} */
|
|
22332
22335
|
getStyles(): IStyleCollection;
|
|
22333
22336
|
/** {@inheritDoc ISheet.getResources} */
|
|
@@ -22462,7 +22465,7 @@ declare module "sheet/SheetRange" {
|
|
|
22462
22465
|
import type { ISheet } from "sheet/ISheet";
|
|
22463
22466
|
import { Sheet } from "sheet/Sheet";
|
|
22464
22467
|
export interface SheetRangeOptions {
|
|
22465
|
-
|
|
22468
|
+
ignoreHidden?: boolean;
|
|
22466
22469
|
readOnly?: string;
|
|
22467
22470
|
getOptions: ICellRange.GetRangeOptions;
|
|
22468
22471
|
}
|
|
@@ -22490,10 +22493,12 @@ declare module "sheet/SheetRange" {
|
|
|
22490
22493
|
protected _deriveRange(address: ICellRange.Address, options: ICellRange.GetRangeOptions, callback?: (newCoords: IRange.Coords, origCoords: IRange.Coords) => IRange.Coords): this;
|
|
22491
22494
|
/** @internal */
|
|
22492
22495
|
protected _validateMaxSize(maxSize?: number): void;
|
|
22493
|
-
/** {@inheritDoc ICellRange[Symbol.iterator]} */
|
|
22494
|
-
[Symbol.iterator](): IterableIterator<Scalar>;
|
|
22495
22496
|
/** {@inheritDoc ICellRange.entries} */
|
|
22496
22497
|
entries(options?: ICellRange.IteratorOptions): IterableIterator<ICellRange.Entry>;
|
|
22498
|
+
/** {@inheritDoc ICellRange[Symbol.iterator]} */
|
|
22499
|
+
[Symbol.iterator](): IterableIterator<Scalar>;
|
|
22500
|
+
/** {@inheritDoc ICellRange.values} */
|
|
22501
|
+
values(options?: ICellRange.IteratorOptions): IterableIterator<Scalar>;
|
|
22497
22502
|
/** {@inheritDoc ICellRange.forEach} */
|
|
22498
22503
|
forEach<T>(callback: ICellRange.ForEachCallback, optionsIterator?: ICellRange.IteratorOptions): T | void;
|
|
22499
22504
|
/** @internal */
|
|
@@ -22510,6 +22515,8 @@ declare module "sheet/SheetRange" {
|
|
|
22510
22515
|
protected _setValueOrValues(value: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
|
|
22511
22516
|
/** {@inheritDoc ICellRange.getValues} */
|
|
22512
22517
|
getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
|
|
22518
|
+
/** {@inheritDoc ICellRange.toText} */
|
|
22519
|
+
toText(options?: ICellRange.ToTextOptions): string;
|
|
22513
22520
|
/** {@inheritDoc ICellRange.getValues} */
|
|
22514
22521
|
getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
|
|
22515
22522
|
/** {@inheritDoc ICellRange.calculate} */
|
|
@@ -22523,7 +22530,7 @@ declare module "sheet/SheetRange" {
|
|
|
22523
22530
|
/** {@inheritDoc ICellRange.select} */
|
|
22524
22531
|
select(options?: ICellRange.SelectOptions): Promise<this>;
|
|
22525
22532
|
/** {@inheritDoc ICellRange.find} */
|
|
22526
|
-
find(
|
|
22533
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22527
22534
|
/** {@inheritDoc ICellRange.getFixed} */
|
|
22528
22535
|
getFixed(options: ICellRange.GetFixedOptions): this;
|
|
22529
22536
|
/** {@inheritDoc ICellRange.getSurrounding} */
|
|
@@ -22625,13 +22632,13 @@ declare module "sheet/SheetRange" {
|
|
|
22625
22632
|
/** {@inheritDoc ICellRange.unmerge} */
|
|
22626
22633
|
unmerge(options?: ITransaction.OperationOptions): this;
|
|
22627
22634
|
/** {@inheritDoc ICellRange.insert} */
|
|
22628
|
-
insert(
|
|
22635
|
+
insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
|
|
22629
22636
|
/** {@inheritDoc ICellRange.insertFrom} */
|
|
22630
22637
|
insertFrom(source: ICellRange.Address | ICellRange.ISnapshot, options?: ICellRange.InsertFromOptions): Promise<this | null>;
|
|
22631
22638
|
/** {@inheritDoc ICellRange.copyFrom} */
|
|
22632
22639
|
copyFrom(source: ICellRange.Address | ICellRange.ISnapshot, options?: ICellRange.CopyOptions): Promise<this | null>;
|
|
22633
22640
|
/** {@inheritDoc ICellRange.delete} */
|
|
22634
|
-
delete(
|
|
22641
|
+
delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
|
|
22635
22642
|
/** {@inheritDoc ICellRange.sort} */
|
|
22636
22643
|
sort(options?: boolean | (ISort.RangeOptions & ITransaction.OperationOptions)): this;
|
|
22637
22644
|
/** {@inheritDoc ICellRange.doBatch} */
|
|
@@ -22880,7 +22887,7 @@ declare module "workbook/Workbook" {
|
|
|
22880
22887
|
/** @internal */
|
|
22881
22888
|
protected _findOffsetForId(id: number, refs: SheetRef[]): number;
|
|
22882
22889
|
/** {@inheritDoc IWorkbook.find} */
|
|
22883
|
-
find(
|
|
22890
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22884
22891
|
/** {@inheritDoc IWorkbook.replace} */
|
|
22885
22892
|
replace(cells: Iterator<ICell>, replace: ICell.Update | ((original: ICell) => ICell.Update), options?: IWorkbook.ReplaceOptions): IWorkbook.ReplaceResults;
|
|
22886
22893
|
/** @internal */
|
|
@@ -22948,7 +22955,7 @@ declare module "workbook/Workbook" {
|
|
|
22948
22955
|
/** @internal */
|
|
22949
22956
|
protected _createScripts(json?: Record<string, IModule.JSON>): IScript;
|
|
22950
22957
|
/** {@inheritDoc IWorkbook.toJSON} */
|
|
22951
|
-
toJSON(
|
|
22958
|
+
toJSON(ignoreData?: boolean): Promise<IWorkbook.JSON>;
|
|
22952
22959
|
/** {@inheritDoc IWorkbook.isClosed} */
|
|
22953
22960
|
isClosed(): boolean;
|
|
22954
22961
|
/** {@inheritDoc IWorkbook.close} */
|
|
@@ -23406,7 +23413,7 @@ declare module "sheet/ISheet" {
|
|
|
23406
23413
|
* @see
|
|
23407
23414
|
* {@link ICellRange.find}
|
|
23408
23415
|
*/
|
|
23409
|
-
find(
|
|
23416
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
23410
23417
|
/**
|
|
23411
23418
|
* Enable and return an {@link IAutoFilter}.
|
|
23412
23419
|
*
|
|
@@ -23610,9 +23617,9 @@ declare module "sheet/ISheet" {
|
|
|
23610
23617
|
/**
|
|
23611
23618
|
* Returns a JSON representation of the sheet.
|
|
23612
23619
|
*
|
|
23613
|
-
* @param
|
|
23620
|
+
* @param ignoreData If `true` only meta data about the sheet will be saved.
|
|
23614
23621
|
*/
|
|
23615
|
-
toJSON(
|
|
23622
|
+
toJSON(ignoreData?: boolean): Promise<ISheet.JSON>;
|
|
23616
23623
|
/**
|
|
23617
23624
|
* Free all resources associated with the sheet.
|
|
23618
23625
|
*
|
|
@@ -23800,7 +23807,7 @@ declare module "sheet/ISheet" {
|
|
|
23800
23807
|
* @remarks
|
|
23801
23808
|
* This should only be handled by one consumer.
|
|
23802
23809
|
*/
|
|
23803
|
-
onRequestScrollIntoView?(source: ISheet, options: ScrollToOptions): Promise<boolean>;
|
|
23810
|
+
onRequestScrollIntoView?(source: ISheet, options: ISheet.ScrollToOptions): Promise<boolean>;
|
|
23804
23811
|
/**
|
|
23805
23812
|
* Request that the sheet become focused.
|
|
23806
23813
|
* @returns A promise indicating if the focus was honored.
|
|
@@ -24350,8 +24357,17 @@ declare module "sheet/_SheetUtils" {
|
|
|
24350
24357
|
* @internal
|
|
24351
24358
|
*/
|
|
24352
24359
|
export const mergeRangeStateIntersections: (ranges: readonly ITypes.RangeCoordValue<RangeState.Intersection>[]) => RangeState.Intersection;
|
|
24353
|
-
/**
|
|
24360
|
+
/**
|
|
24361
|
+
* @internal
|
|
24362
|
+
* * TODO - Use a lower level iterator to avoid cell context?
|
|
24363
|
+
*/
|
|
24354
24364
|
export const cellStateIteratorTo2DArray: (iteratorCallback: (options?: CellState.IteratorOptions) => Iterator<ICellRange.Entry, ICellRange.Entry, IRange.CellCoords>, bounds: IRange.Coords, asCells: boolean, options: ICellRange.GetValuesOptions) => (ICell | JSScalar)[][];
|
|
24365
|
+
/**
|
|
24366
|
+
* @internal
|
|
24367
|
+
* TODO - rationalize this with cellStateIteratorTo2DArray?
|
|
24368
|
+
* TODO - Use a lower level iterator to avoid cell context?
|
|
24369
|
+
*/
|
|
24370
|
+
export const cellStateIteratorToString: (iteratorCallback: (options?: CellState.IteratorOptions) => Iterator<ICellRange.Entry, ICellRange.Entry, IRange.CellCoords>, bounds: IRange.Coords, options: ICellRange.ToTextOptions) => string;
|
|
24355
24371
|
export const isEqualSheetRanges: (a?: IRange.FixableCoords, b?: IRange.FixableCoords) => boolean;
|
|
24356
24372
|
/**
|
|
24357
24373
|
* Check if two ranges arrays are equal
|
|
@@ -29795,7 +29811,7 @@ declare module "cell/ICellProtection" {
|
|
|
29795
29811
|
}
|
|
29796
29812
|
declare module "cell/ICell" {
|
|
29797
29813
|
import type { Scalar, JSScalarUpdate, ScalarType, IRange } from '@sheetxl/primitives';
|
|
29798
|
-
import type {
|
|
29814
|
+
import type { Size, Rectangle, Bounds } from '@sheetxl/utils';
|
|
29799
29815
|
import type { ITypes } from "type/index";
|
|
29800
29816
|
import type { ITextFrame } from "text/index";
|
|
29801
29817
|
import type { NumberFormat } from "numFmt/index";
|
|
@@ -29886,12 +29902,10 @@ declare module "cell/ICell" {
|
|
|
29886
29902
|
/**
|
|
29887
29903
|
* Returns the cell's value as a formatted string, applying any number formatting.
|
|
29888
29904
|
*
|
|
29889
|
-
* @param numFmt A custom number format to apply (optional).
|
|
29890
|
-
*
|
|
29891
29905
|
* @see
|
|
29892
29906
|
* {@link toTextUnformatted}
|
|
29893
29907
|
*/
|
|
29894
|
-
toText(
|
|
29908
|
+
toText(): string;
|
|
29895
29909
|
/**
|
|
29896
29910
|
* Returns the cell's value as an unformatted string.
|
|
29897
29911
|
*
|
|
@@ -29938,7 +29952,7 @@ declare module "cell/ICell" {
|
|
|
29938
29952
|
* Returns `null` if this cell should be ignored for sizing purposes.
|
|
29939
29953
|
* Either dimension can also be `null`, indicating that the specific direction should not be used.
|
|
29940
29954
|
*/
|
|
29941
|
-
getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<
|
|
29955
|
+
getBestFit(colWidth?: number, minContent?: boolean): Readonly<Partial<Size>> | null;
|
|
29942
29956
|
/**
|
|
29943
29957
|
* Returns protection information.
|
|
29944
29958
|
*/
|
|
@@ -29953,7 +29967,7 @@ declare module "cell/ICell" {
|
|
|
29953
29967
|
/**
|
|
29954
29968
|
* Returns the span dimensions for merged cells.
|
|
29955
29969
|
*/
|
|
29956
|
-
getSpans(): Readonly<
|
|
29970
|
+
getSpans(): Readonly<Size>;
|
|
29957
29971
|
/**
|
|
29958
29972
|
* 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
29973
|
*/
|
|
@@ -31459,7 +31473,7 @@ declare module "sort/ISort" {
|
|
|
31459
31473
|
interface DefaultSortCriteria {
|
|
31460
31474
|
/**
|
|
31461
31475
|
* The cords that will be sorted.
|
|
31462
|
-
* This may
|
|
31476
|
+
* This may ignore the header.
|
|
31463
31477
|
*/
|
|
31464
31478
|
coords: IRange.Coords;
|
|
31465
31479
|
/**
|
|
@@ -31586,7 +31600,7 @@ declare module "cellRange/ICellRanges" {
|
|
|
31586
31600
|
/**
|
|
31587
31601
|
* {@inheritDoc ICellRange.find}
|
|
31588
31602
|
*/
|
|
31589
|
-
find(
|
|
31603
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
31590
31604
|
/**
|
|
31591
31605
|
* Iterates over the values, yielding each values in the collection.
|
|
31592
31606
|
*
|
|
@@ -31622,7 +31636,7 @@ declare module "cellRange/ICellRanges" {
|
|
|
31622
31636
|
/**
|
|
31623
31637
|
* {@inheritDoc ICellRange.merge}
|
|
31624
31638
|
*/
|
|
31625
|
-
merge(options?:
|
|
31639
|
+
merge(options?: IRange.Orientations | ICellRange.MergeOptions): this;
|
|
31626
31640
|
/**
|
|
31627
31641
|
* {@inheritDoc ICellRange.unmerge}
|
|
31628
31642
|
*/
|
|
@@ -31630,11 +31644,11 @@ declare module "cellRange/ICellRanges" {
|
|
|
31630
31644
|
/**
|
|
31631
31645
|
* {@inheritDoc ICellRange.insert}
|
|
31632
31646
|
*/
|
|
31633
|
-
insert(
|
|
31647
|
+
insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
|
|
31634
31648
|
/**
|
|
31635
31649
|
* {@inheritDoc ICellRange.delete}
|
|
31636
31650
|
*/
|
|
31637
|
-
delete(
|
|
31651
|
+
delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
|
|
31638
31652
|
/**
|
|
31639
31653
|
* {@inheritDoc ICellRange.insertFrom}
|
|
31640
31654
|
*/
|
|
@@ -32003,7 +32017,7 @@ declare module "cellRange/ICellHeaderRange" {
|
|
|
32003
32017
|
* optionally a header orientation for skipping case be passed in.
|
|
32004
32018
|
* An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
|
|
32005
32019
|
*/
|
|
32006
|
-
|
|
32020
|
+
ignoreHidden?: boolean;
|
|
32007
32021
|
}
|
|
32008
32022
|
/**
|
|
32009
32023
|
* Context for Iterators to provide access to the `IRange.CellCoords`, the `ICellHeader`, and additional operators.
|
|
@@ -32199,7 +32213,7 @@ declare module "cellRange/ICellRange" {
|
|
|
32199
32213
|
* Returns the value for the top left `Scalar`.
|
|
32200
32214
|
*
|
|
32201
32215
|
* @remarks
|
|
32202
|
-
* The `
|
|
32216
|
+
* The `ignoreHidden` option is ignored.
|
|
32203
32217
|
*
|
|
32204
32218
|
* @see
|
|
32205
32219
|
* {@link ICellRange.getValues}
|
|
@@ -32409,6 +32423,10 @@ declare module "cellRange/ICellRange" {
|
|
|
32409
32423
|
* * Setting {@link ICellRange.GetValuesOptions.asJSDate} to `true` will add make slower.
|
|
32410
32424
|
*/
|
|
32411
32425
|
getValues(options?: ICellRange.GetValuesOptions): Scalar[][];
|
|
32426
|
+
/**
|
|
32427
|
+
* Returns the range value as a string.
|
|
32428
|
+
*/
|
|
32429
|
+
toText(options?: ICellRange.ToTextOptions): string;
|
|
32412
32430
|
/**
|
|
32413
32431
|
* Set the value(s) of one or more cells within a range.
|
|
32414
32432
|
*
|
|
@@ -32425,6 +32443,7 @@ declare module "cellRange/ICellRange" {
|
|
|
32425
32443
|
setValues(values: ICellRange.ValuesUpdate, options?: ICellRange.SetValuesOptions): this;
|
|
32426
32444
|
/**
|
|
32427
32445
|
* Provides a convenient method for setting values with a range of calls.
|
|
32446
|
+
*
|
|
32428
32447
|
* @param update {@link ICellRange.Update}
|
|
32429
32448
|
* @param options {@link ICellRange.UpdateCellsOptions}
|
|
32430
32449
|
* @returns The current `ICellRange`.
|
|
@@ -32536,10 +32555,9 @@ declare module "cellRange/ICellRange" {
|
|
|
32536
32555
|
/**
|
|
32537
32556
|
* Returns an iterator of ICells that match the results.
|
|
32538
32557
|
*
|
|
32539
|
-
* @param
|
|
32540
|
-
* @param options {@link FindOptions}
|
|
32558
|
+
* @param options The text to search for or {@link FindOptions}
|
|
32541
32559
|
*/
|
|
32542
|
-
find(
|
|
32560
|
+
find(options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
32543
32561
|
/**
|
|
32544
32562
|
* Sort the given range.
|
|
32545
32563
|
*
|
|
@@ -32557,28 +32575,28 @@ declare module "cellRange/ICellRange" {
|
|
|
32557
32575
|
* By default the values will direction in whichever direction the selection shape is smaller.
|
|
32558
32576
|
* For example a selection with a 5 column by 1 row will direction Down (rows).
|
|
32559
32577
|
* Note - This will error if direction data will fall outsize of the max sheet size.
|
|
32560
|
-
* @param orientation The direction in which to shift existing cells.
|
|
32578
|
+
* @param options The orientation or The direction in which to shift existing cells.
|
|
32561
32579
|
* Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
|
|
32562
32580
|
* See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
|
|
32563
|
-
*
|
|
32581
|
+
* See {@link ITransaction.OperationOptions}
|
|
32564
32582
|
* @throws `Error` If the insertion would cause data to exceed the maximum sheet size.
|
|
32565
32583
|
* @returns Current `ICellRange`.
|
|
32566
32584
|
*/
|
|
32567
|
-
insert(
|
|
32585
|
+
insert(options?: IRange.Orientation | ICellRange.InsertOptions): this;
|
|
32568
32586
|
/**
|
|
32569
32587
|
* Delete the cells within the range and shifts the remaining cells to fill the gap.
|
|
32570
32588
|
*
|
|
32571
|
-
* @param orientation The direction in which to shift
|
|
32572
|
-
* Defaults to the orientation where the range's dimension is smaller (e.g., shifts
|
|
32589
|
+
* @param options The orientation or The direction in which to shift existing cells.
|
|
32590
|
+
* Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
|
|
32573
32591
|
* See {@link ICellRange.getDefaultShiftOrientation} for details on the default behavior.
|
|
32574
|
-
*
|
|
32592
|
+
* See {@link ITransaction.OperationOptions}
|
|
32575
32593
|
* @returns Current `ICellRange`.
|
|
32576
32594
|
*
|
|
32577
32595
|
* @remarks
|
|
32578
32596
|
* This is different from clearing cells, which removes their content but doesn't affect the
|
|
32579
32597
|
* overall sheet structure. Deleting cells results in a shift of the remaining data.
|
|
32580
32598
|
*/
|
|
32581
|
-
delete(
|
|
32599
|
+
delete(options?: IRange.Orientation | ICellRange.DeleteOptions): this;
|
|
32582
32600
|
/**
|
|
32583
32601
|
* Returns a snapshot of the current range's data and formatting suitable for copying or archiving.
|
|
32584
32602
|
*
|
|
@@ -32809,6 +32827,13 @@ declare module "cellRange/ICellRange" {
|
|
|
32809
32827
|
* @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
|
|
32810
32828
|
*/
|
|
32811
32829
|
entries(options?: ICellRange.IteratorOptions): IterableIterator<ICellRange.Entry>;
|
|
32830
|
+
/**
|
|
32831
|
+
* Returns the values within the range, yielding each value.
|
|
32832
|
+
*
|
|
32833
|
+
* @param options Configuration options for the iterator, such as filtering or sorting.
|
|
32834
|
+
* @returns An iterator that yields `[ICell.IteratorContext, Value]` tuples for each value within the range.
|
|
32835
|
+
*/
|
|
32836
|
+
values(options?: ICellRange.IteratorOptions): IterableIterator<Scalar>;
|
|
32812
32837
|
/**
|
|
32813
32838
|
* Iterates over the cells within the range, applying the provided callback function to each cell.
|
|
32814
32839
|
*
|
|
@@ -32864,6 +32889,28 @@ declare module "cellRange/ICellRange" {
|
|
|
32864
32889
|
*/
|
|
32865
32890
|
interface GetRangeOptions {
|
|
32866
32891
|
}
|
|
32892
|
+
/**
|
|
32893
|
+
* Options for `ICellRange.delete`.
|
|
32894
|
+
*/
|
|
32895
|
+
interface InsertOptions extends ITransaction.OperationOptions {
|
|
32896
|
+
/**
|
|
32897
|
+
* The direction in which to shift existing cells.
|
|
32898
|
+
* Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
|
|
32899
|
+
* See {@link ICellRange.getDefaultShiftOrientation}
|
|
32900
|
+
*/
|
|
32901
|
+
orientation?: IRange.Orientation;
|
|
32902
|
+
}
|
|
32903
|
+
/**
|
|
32904
|
+
* Options for `ICellRange.delete`.
|
|
32905
|
+
*/
|
|
32906
|
+
interface DeleteOptions extends ITransaction.OperationOptions {
|
|
32907
|
+
/**
|
|
32908
|
+
* The direction in which to shift existing cells.
|
|
32909
|
+
* Defaults to the orientation where the range's dimension is smaller (e.g., shifts down if the range is wider than it is tall).
|
|
32910
|
+
* See {@link ICellRange.getDefaultShiftOrientation}
|
|
32911
|
+
*/
|
|
32912
|
+
orientation?: IRange.Orientation;
|
|
32913
|
+
}
|
|
32867
32914
|
/**
|
|
32868
32915
|
* Shorthand for persisting.
|
|
32869
32916
|
*/
|
|
@@ -33068,10 +33115,16 @@ declare module "cellRange/ICellRange" {
|
|
|
33068
33115
|
* - Optionally, you can specify a `IRange.Orientation` to indicate the header orientation for skipping cases.
|
|
33069
33116
|
* For example, in sorting, you might want to skip hidden rows but not hidden columns.
|
|
33070
33117
|
*/
|
|
33071
|
-
|
|
33118
|
+
ignoreHidden?: boolean | IRange.Orientation;
|
|
33072
33119
|
/** {@inheritDoc ICellRange.IteratorOptions.includeMergeOverflow} */
|
|
33073
33120
|
includeMergeOverflow?: boolean;
|
|
33074
33121
|
}
|
|
33122
|
+
/**
|
|
33123
|
+
* Options for {@link ICellRange.toText}.
|
|
33124
|
+
*/
|
|
33125
|
+
interface ToTextOptions extends ICellRange.GetValuesOptions {
|
|
33126
|
+
ignoreFormatting?: boolean;
|
|
33127
|
+
}
|
|
33075
33128
|
/**
|
|
33076
33129
|
* Options for {@link ICellRange.autoFit}.
|
|
33077
33130
|
*/
|
|
@@ -33323,6 +33376,12 @@ declare module "cellRange/ICellRange" {
|
|
|
33323
33376
|
* Options for {@link ICellRange.find}.
|
|
33324
33377
|
*/
|
|
33325
33378
|
interface FindOptions extends FindCriteria {
|
|
33379
|
+
/**
|
|
33380
|
+
* The text to search for.
|
|
33381
|
+
*
|
|
33382
|
+
* @required
|
|
33383
|
+
*/
|
|
33384
|
+
text: string;
|
|
33326
33385
|
/**
|
|
33327
33386
|
* Provides custom logic for matching values during the find operation.
|
|
33328
33387
|
*
|
|
@@ -33464,6 +33523,15 @@ declare module "cellRange/ICellRange" {
|
|
|
33464
33523
|
* Alias type for count results by type.
|
|
33465
33524
|
*/
|
|
33466
33525
|
type Counts = Partial<Record<ICell.Content, number>>;
|
|
33526
|
+
interface ScrollIntoViewOptions extends globalThis.ScrollIntoViewOptions {
|
|
33527
|
+
/**
|
|
33528
|
+
* If provided then will only scroll in the provided orientation.
|
|
33529
|
+
*
|
|
33530
|
+
* @remarks
|
|
33531
|
+
* This is useful for only scrolling vertically or horizontally for insert/deleteCells
|
|
33532
|
+
*/
|
|
33533
|
+
orientation?: IRange.Orientation;
|
|
33534
|
+
}
|
|
33467
33535
|
/**
|
|
33468
33536
|
* Extends SelectionOptions to include the option to adjust the anchor cell.
|
|
33469
33537
|
*/
|
|
@@ -33477,6 +33545,17 @@ declare module "cellRange/ICellRange" {
|
|
|
33477
33545
|
* If the current anchor is not within the current range this will be forced to `true`.
|
|
33478
33546
|
*/
|
|
33479
33547
|
anchor?: boolean | Partial<IRange.CellCoords>;
|
|
33548
|
+
/**
|
|
33549
|
+
* If `true` or if a valid `ScrollIntoViewOptions` object is provided,
|
|
33550
|
+
* the selected element will be scrolled into view.
|
|
33551
|
+
*
|
|
33552
|
+
* @remarks
|
|
33553
|
+
* - If a `ScrollIntoViewOptions` object is provided, it will control the exact scrolling behavior.
|
|
33554
|
+
* - If `false` (or omitted), the selected element will not be scrolled into view.
|
|
33555
|
+
*
|
|
33556
|
+
* @defaultValue false
|
|
33557
|
+
*/
|
|
33558
|
+
scrollIntoView?: boolean | ICellRange.ScrollIntoViewOptions;
|
|
33480
33559
|
}
|
|
33481
33560
|
/**
|
|
33482
33561
|
* Options for customizing how values are retrieved from a range and returned as a 2D array.
|
|
@@ -33510,7 +33589,7 @@ declare module "cellRange/ICellRange" {
|
|
|
33510
33589
|
* Optionally a header orientation for skipping case be passed in.
|
|
33511
33590
|
* An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.
|
|
33512
33591
|
*/
|
|
33513
|
-
|
|
33592
|
+
ignoreHidden?: boolean | IRange.Orientation;
|
|
33514
33593
|
/**
|
|
33515
33594
|
* If set to true the only the raw values will be visited.
|
|
33516
33595
|
*
|
|
@@ -33519,7 +33598,7 @@ declare module "cellRange/ICellRange" {
|
|
|
33519
33598
|
* @remarks
|
|
33520
33599
|
* This allows for much faster reading when only the value is needed.
|
|
33521
33600
|
*/
|
|
33522
|
-
|
|
33601
|
+
ignoreCellDetails?: boolean;
|
|
33523
33602
|
/**
|
|
33524
33603
|
* Includes any merge overflow in first element visited.
|
|
33525
33604
|
*
|