@sheetxl/sdk 0.7.19 → 0.7.21
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/browser/cjs/{DODJ56uKXuMHBqUD.cjs → B1wkCHMcDuFkMcC_.cjs} +1 -1
- package/browser/cjs/{DzGSQzHR7LuZVCHk.cjs → B6GPcN051NmcYcIT.cjs} +2 -2
- package/browser/cjs/{9eLW8qnyDnIczGNg.cjs → BLBAZ-Bmj0EAhunn.cjs} +1 -1
- package/browser/cjs/{COFIhECWXKH2vKQh.cjs → BP8dBZEDNeacQUNp.cjs} +3 -3
- package/browser/cjs/{DCdIYRDWVYKQUtSr.cjs → BhNultME1o9xbmcX.cjs} +2 -2
- package/browser/cjs/{BFHcO95DPI5PXeNW.cjs → Bm_Mc6TDFCZ1OJNj.cjs} +1 -1
- package/browser/cjs/{CQuMp0DaPHLylzzs.cjs → Bo1CE3hgxUD5DGqu.cjs} +1 -1
- package/browser/cjs/{exZZohur71emWSB8.cjs → Btp8A0kzb6cHSEMD.cjs} +1 -1
- package/browser/cjs/{5Ec7uqe_KzqaHYUn.cjs → BvS2Hclafqxj6DCP.cjs} +1 -1
- package/browser/cjs/{DxlrlBRIcBoXAO_Q.cjs → CASsDxt2bA8JHiEW.cjs} +1 -1
- package/browser/cjs/CI7HTC82ehwZZ7G9.cjs +55 -0
- package/browser/cjs/{Cuxtf2wvDMMrF6jZ.cjs → CNw4tHphpF3kplDH.cjs} +1 -1
- package/browser/cjs/{B-dxb9qiwpGDukV1.cjs → CO7SAK1ru6qnh7fr.cjs} +1 -1
- package/browser/cjs/{BV2mVZVmmoeCEsow.cjs → CdLUUmZCUY5uWnq5.cjs} +1 -1
- package/browser/cjs/{D9upaBte_0A9NsBE.cjs → Cegi9isUAUZKUYFl.cjs} +1 -1
- package/browser/cjs/{CJqmqCC82qly_N9O.cjs → CnlnOI_NWWeETB4i.cjs} +1 -1
- package/browser/cjs/{DHHpCsWylq2ilkNg.cjs → CphmaCdyCfgLRsS0.cjs} +1 -1
- package/browser/cjs/{cajx4-BtrcsHmwLQ.cjs → D0Qme7PcsKfdtShi.cjs} +1 -1
- package/browser/cjs/{CVUsSNwxfYFGzFmq.cjs → D74bWkyzhU8E2TDh.cjs} +1 -1
- package/browser/cjs/{DMXmAnbKdyBh5HJe.cjs → DFQA35q7KQ-zS2eo.cjs} +1 -1
- package/browser/cjs/{C0BGV_db6RPmpTn6.cjs → DK27kwlwz0N4_IpD.cjs} +1 -1
- package/browser/cjs/{BiwYy7jsLimHBJtb.cjs → DMfUZBX5dMS-QcFB.cjs} +1 -1
- package/browser/cjs/{CJQxCfdVcdoEkk5J.cjs → DTrbxLKRbIsj3mPI.cjs} +1 -1
- package/browser/cjs/{XVXCDepnSGD3-r2I.cjs → DUbyVNEdEpgkjI-U.cjs} +1 -1
- package/browser/cjs/{DtmfArGNC0VE8BfY.cjs → DUiZ8WcVcUyjfILT.cjs} +1 -1
- package/browser/cjs/{Da5aRgCxp8hX6730.cjs → DzZ_6y4OF7HzFZLT.cjs} +1 -1
- package/browser/cjs/index.cjs +2 -2
- package/browser/cjs/{9falDGOhQd1uqt7E.cjs → vQgVD2EniUvkeXnq.cjs} +1 -1
- package/browser/esm/{BT3Pkk0D24yI07K3.mjs → B8depZMfw4f8vJ6H.mjs} +1 -1
- package/browser/esm/{5aCbF-pPxIWT9fPD.mjs → B9z2sURkI9ThbLxE.mjs} +1 -1
- package/browser/esm/{Bxay6ecg3uP5lNgt.mjs → BDSqdyFcw4FRrODg.mjs} +7014 -6966
- package/{node/esm/B1Owkps-kCSGNo71.mjs → browser/esm/BLoU0uz84A8fWYom.mjs} +1 -1
- package/browser/esm/{_XKsIuqSGLSVkhUJ.mjs → BgKy-xWSJeSV_EyO.mjs} +1 -1
- package/{node/esm/wRnJv89npiCcfS74.mjs → browser/esm/Bi2_8iLEY_M-v_34.mjs} +1 -1
- package/browser/esm/{Behw0s4Vl9hYzSQn.mjs → Bzs_r45vqhZAtTZK.mjs} +1 -1
- package/browser/esm/{DLPNARxxIWtrQUxW.mjs → C39Yfk__mPOF8auo.mjs} +1 -1
- package/browser/esm/{D-HGwDEmxhcjKRh9.mjs → C4EnSMaP8fTEJmhu.mjs} +1 -1
- package/browser/esm/{WdshuHfK_r13CmXu.mjs → CWj2Ts01muSR6zp-.mjs} +1 -1
- package/browser/esm/{DCKJEq_tqYmgRj1v.mjs → Cd2b3Z4DxOR0M3qa.mjs} +15 -12
- package/{node/esm/qz2XX5Zz1o0vswQF.mjs → browser/esm/Cg7YNnt2uhmFG_3d.mjs} +1 -1
- package/browser/esm/{EX90VzZjHii6-74z.mjs → CkU9J_RtpNfpxh0y.mjs} +1 -1
- package/browser/esm/{CgIV4RmEXKz1vO-c.mjs → D0Mb17_7UFEFNmkU.mjs} +2 -2
- package/{node/esm/qTvKaICzD2TRbmKO.mjs → browser/esm/D6VvBNUOfq8QUBY5.mjs} +1 -1
- package/{node/esm/BcXrVnCDoObUaQ86.mjs → browser/esm/DE0iHIHhP7sczC_y.mjs} +1 -1
- package/browser/esm/{Cbe5R2so2CiFfqM5.mjs → DORXFXgRUsjkR1kA.mjs} +1 -1
- package/browser/esm/{DgwfnwqUoUFH_y7j.mjs → DTPLUnlOvF2feqR4.mjs} +1 -1
- package/{node/esm/Dwkp_uj3FyE2W4ql.mjs → browser/esm/DTzUiMAnLD_Zuf0f.mjs} +1 -1
- package/{node/esm/GnFUK3ZiX7CfU_rY.mjs → browser/esm/D_lQo-PErOoj-8tN.mjs} +1 -1
- package/{node/esm/BW9ehwNOKmjebpua.mjs → browser/esm/DbK0GAKpj9hwwFwY.mjs} +1 -1
- package/browser/esm/{Bla4Tm-f1RgXR6Xt.mjs → DflesN5VzS43jsHK.mjs} +2 -2
- package/browser/esm/{BLiMgJqZVen3oPi3.mjs → DoMqoQP6F7OPue_g.mjs} +1 -1
- package/browser/esm/{GtI6yffY8DXIptU5.mjs → DrIkV6ixO7gbuv7Q.mjs} +1 -1
- package/browser/esm/index.mjs +48 -46
- package/browser/esm/{4OnzR9YwWqxWCbLx.mjs → mxYovIi79sCzcZtQ.mjs} +1 -1
- package/{node/esm/AuP5ZjL5xNhx38LV.mjs → browser/esm/oRsIla0R_H7slM9k.mjs} +1 -1
- package/browser/esm/{7B6Obu_Ya-gQ10dC.mjs → u5XTTNCFdsbCZ-ud.mjs} +1 -1
- package/node/esm/{D-OhdsCsmrzkSf9e.mjs → 3vOMW8PI4UI73pTa.mjs} +1 -1
- package/node/esm/{5aCbF-pPxIWT9fPD.mjs → B9z2sURkI9ThbLxE.mjs} +1 -1
- package/node/esm/{Cu2RC8MhdPYMbQdD.mjs → BE2XMKirjoBI9zkt.mjs} +1 -1
- package/node/esm/{GIARNN3tc_0GNfFD.mjs → BL_7m0SH43tASZc8.mjs} +1 -1
- package/{browser/esm/B1Owkps-kCSGNo71.mjs → node/esm/BLoU0uz84A8fWYom.mjs} +1 -1
- package/node/esm/{DNV4Zh8yqwrLYSkN.mjs → BNoPG6CBaybfp_G7.mjs} +1 -1
- package/node/esm/{_XKsIuqSGLSVkhUJ.mjs → BgKy-xWSJeSV_EyO.mjs} +1 -1
- package/{browser/esm/wRnJv89npiCcfS74.mjs → node/esm/Bi2_8iLEY_M-v_34.mjs} +1 -1
- package/node/esm/{D-HGwDEmxhcjKRh9.mjs → C4EnSMaP8fTEJmhu.mjs} +1 -1
- package/node/esm/{B5ltFB1YT5B2r9RK.mjs → CS080xy3HgmgAFgx.mjs} +1 -1
- package/{browser/esm/qz2XX5Zz1o0vswQF.mjs → node/esm/Cg7YNnt2uhmFG_3d.mjs} +1 -1
- package/{browser/esm/qTvKaICzD2TRbmKO.mjs → node/esm/D6VvBNUOfq8QUBY5.mjs} +1 -1
- package/node/esm/{DMbCamPzz9vVfYdv.mjs → D7cm1_99nK7c_-6L.mjs} +1 -1
- package/{browser/esm/BcXrVnCDoObUaQ86.mjs → node/esm/DE0iHIHhP7sczC_y.mjs} +1 -1
- package/node/esm/{C9J55b2W8sv680zc.mjs → DElHitSTYjDdkUx1.mjs} +1 -1
- package/node/esm/{Cbe5R2so2CiFfqM5.mjs → DORXFXgRUsjkR1kA.mjs} +1 -1
- package/node/esm/{18-IgFR3zjp3E9CY.mjs → DP7a0Jrz8vTZnv2W.mjs} +1 -1
- package/{browser/esm/Dwkp_uj3FyE2W4ql.mjs → node/esm/DTzUiMAnLD_Zuf0f.mjs} +1 -1
- package/{browser/esm/GnFUK3ZiX7CfU_rY.mjs → node/esm/D_lQo-PErOoj-8tN.mjs} +1 -1
- package/{browser/esm/BW9ehwNOKmjebpua.mjs → node/esm/DbK0GAKpj9hwwFwY.mjs} +1 -1
- package/node/esm/{BLiMgJqZVen3oPi3.mjs → DoMqoQP6F7OPue_g.mjs} +1 -1
- package/node/esm/index.mjs +3229 -3187
- package/node/esm/{4OnzR9YwWqxWCbLx.mjs → mxYovIi79sCzcZtQ.mjs} +1 -1
- package/{browser/esm/AuP5ZjL5xNhx38LV.mjs → node/esm/oRsIla0R_H7slM9k.mjs} +1 -1
- package/node/esm/{EJE_HywvophL9XZb.mjs → sVuz1UjytOtK5gck.mjs} +14 -11
- package/node/esm/{7B6Obu_Ya-gQ10dC.mjs → u5XTTNCFdsbCZ-ud.mjs} +1 -1
- package/package.json +4 -4
- package/types/index.d.ts +68 -31
- package/types/scripting.d.ts +290 -272
- package/browser/cjs/De3jUs80wQIeNdtk.cjs +0 -55
package/types/scripting.d.ts
CHANGED
|
@@ -8893,12 +8893,14 @@ declare module "table/ITableCollection" {
|
|
|
8893
8893
|
interface AddOptions extends ITransaction.OperationOptions {
|
|
8894
8894
|
/**
|
|
8895
8895
|
* If not specified then the header status will be determined from the range data.
|
|
8896
|
+
*
|
|
8896
8897
|
* @defaultValue 'based on initial data set'
|
|
8897
8898
|
*/
|
|
8898
8899
|
hasHeader?: boolean;
|
|
8899
8900
|
/**
|
|
8900
8901
|
* The default style to use. If null than it will not be set
|
|
8901
8902
|
* If undefined or not provided it will use the.
|
|
8903
|
+
*
|
|
8902
8904
|
* @defaultValue uses the default table style
|
|
8903
8905
|
*/
|
|
8904
8906
|
styleName?: string;
|
|
@@ -10133,12 +10135,12 @@ declare module "calculation/ICalculation" {
|
|
|
10133
10135
|
/** @inheritdoc IFormulaContext.getRuntime */
|
|
10134
10136
|
getRuntime(): IRuntime;
|
|
10135
10137
|
/**
|
|
10136
|
-
*
|
|
10138
|
+
* Calculates all items or waits for current calculations to finished
|
|
10137
10139
|
*
|
|
10138
10140
|
* @remarks
|
|
10139
10141
|
* This is useful when needing to ensure that the values in the calculation cycle are up-to-date.
|
|
10140
10142
|
*/
|
|
10141
|
-
|
|
10143
|
+
calculate(options?: ICalculation.CalculateOptions): Promise<void>;
|
|
10142
10144
|
/**
|
|
10143
10145
|
* Add Listeners.
|
|
10144
10146
|
*
|
|
@@ -10155,6 +10157,15 @@ declare module "calculation/ICalculation" {
|
|
|
10155
10157
|
* {@link ICalculation}
|
|
10156
10158
|
*/
|
|
10157
10159
|
export namespace ICalculation {
|
|
10160
|
+
/**
|
|
10161
|
+
* Options for when calculating.
|
|
10162
|
+
*/
|
|
10163
|
+
interface CalculateOptions {
|
|
10164
|
+
/**
|
|
10165
|
+
* If true a full calc will be done not just invalid values
|
|
10166
|
+
*/
|
|
10167
|
+
full?: boolean;
|
|
10168
|
+
}
|
|
10158
10169
|
/**
|
|
10159
10170
|
* Represents a formula that can be evaluated.
|
|
10160
10171
|
*/
|
|
@@ -14446,175 +14457,6 @@ declare module "primitives/Range" {
|
|
|
14446
14457
|
get isIRange(): true;
|
|
14447
14458
|
}
|
|
14448
14459
|
}
|
|
14449
|
-
declare module "selection/IRangeSelection" {
|
|
14450
|
-
import type { IRange } from '@sheetxl/primitives';
|
|
14451
|
-
import type { SelectionCoords as WellKnownSelectionCoords } from '@sheetxl/utils';
|
|
14452
|
-
import type { IListener } from "listener/index";
|
|
14453
|
-
import type { ISheet } from "sheet/index";
|
|
14454
|
-
/**
|
|
14455
|
-
* Interface representing a range selection within a sheet.
|
|
14456
|
-
*/
|
|
14457
|
-
export interface IRangeSelection {
|
|
14458
|
-
/**
|
|
14459
|
-
* Navigates the entire sheet
|
|
14460
|
-
*
|
|
14461
|
-
* @param direction The direction to navigate.
|
|
14462
|
-
* @param select Whether to select the cell after navigating.
|
|
14463
|
-
* @param contentful Whether to navigate to contentful cells only.
|
|
14464
|
-
* @param incrementAmount The amount to increment.
|
|
14465
|
-
* @returns The current instance.
|
|
14466
|
-
*/
|
|
14467
|
-
navigate(direction: IRange.Direction, select?: boolean, contentful?: boolean, incrementAmount?: number): this;
|
|
14468
|
-
/**
|
|
14469
|
-
* Checks if the entire range is selected.
|
|
14470
|
-
* @returns True if the entire range is selected, otherwise false.
|
|
14471
|
-
*/
|
|
14472
|
-
isEntire(): boolean;
|
|
14473
|
-
/**
|
|
14474
|
-
* Returns the coordinates of the selection.
|
|
14475
|
-
* @returns The selection coordinates.
|
|
14476
|
-
*/
|
|
14477
|
-
getCoords(): IRangeSelection.Coords;
|
|
14478
|
-
/**
|
|
14479
|
-
* Returns the selection as an array of IRange.Coords.
|
|
14480
|
-
*
|
|
14481
|
-
* @param coords Optional coordinates to convert. If not provided, uses the current selection.
|
|
14482
|
-
*
|
|
14483
|
-
* @remarks
|
|
14484
|
-
* The first element is always the active range.
|
|
14485
|
-
*/
|
|
14486
|
-
getRangesCoords(coords?: Partial<IRangeSelection.Coords>): IRange.Coords[];
|
|
14487
|
-
/**
|
|
14488
|
-
* Updates the selection coordinates.
|
|
14489
|
-
*
|
|
14490
|
-
* @param coords The new coordinates.
|
|
14491
|
-
* @returns The current instance.
|
|
14492
|
-
*/
|
|
14493
|
-
updateCoords(coords: IRangeSelection.Coords): this;
|
|
14494
|
-
/**
|
|
14495
|
-
* Traverses the selection, moving to the next cell based on the orientation.
|
|
14496
|
-
*
|
|
14497
|
-
* @param orientation The orientation to traverse. Default is `ICellRange.Orientation.Row`.
|
|
14498
|
-
* @param reverse Whether to traverse in reverse. Default is false.
|
|
14499
|
-
* @returns The current instance.
|
|
14500
|
-
* @remarks Useful for pressing tab or enter from the UI.
|
|
14501
|
-
*/
|
|
14502
|
-
traverse(orientation?: IRange.Orientation, reverse?: boolean): this;
|
|
14503
|
-
/**
|
|
14504
|
-
* Updates the selection using a new start and end.
|
|
14505
|
-
*
|
|
14506
|
-
* @param start The start cell.
|
|
14507
|
-
* @param end The end cell. Default is the start cell.
|
|
14508
|
-
* @param anchor The anchor cell.
|
|
14509
|
-
*/
|
|
14510
|
-
clearAndModify(start: Partial<IRange.CellCoords>, end?: Partial<IRange.CellCoords>, anchor?: Partial<IRange.CellCoords>): void;
|
|
14511
|
-
/**
|
|
14512
|
-
* Modifies the selection around the anchor.
|
|
14513
|
-
*
|
|
14514
|
-
* @param cellAnchor The anchor cell.
|
|
14515
|
-
* @param cellPivot The pivot cell.
|
|
14516
|
-
* @param resetAnchor Whether to reset the anchor. Default is false.
|
|
14517
|
-
*/
|
|
14518
|
-
modify(cellAnchor: Partial<IRange.CellCoords>, cellPivot?: Partial<IRange.CellCoords>, resetAnchor?: boolean): void;
|
|
14519
|
-
/**
|
|
14520
|
-
* Clears the range selections.
|
|
14521
|
-
*
|
|
14522
|
-
* @remarks This does not affect the cell.
|
|
14523
|
-
*/
|
|
14524
|
-
clear(): void;
|
|
14525
|
-
/**
|
|
14526
|
-
* Appends a selection to the current selection.
|
|
14527
|
-
*
|
|
14528
|
-
* @param start The start cell.
|
|
14529
|
-
* @param end The end cell. Default is the start cell.
|
|
14530
|
-
* @param anchor The anchor cell.
|
|
14531
|
-
* @remarks This is used to support the CMD key behavior in the UI.
|
|
14532
|
-
*/
|
|
14533
|
-
append(start: IRange.CellCoords, end?: IRange.CellCoords, anchor?: Partial<IRange.CellCoords>): void;
|
|
14534
|
-
/**
|
|
14535
|
-
* A special range used during drag.
|
|
14536
|
-
* @param range The range or null.
|
|
14537
|
-
*
|
|
14538
|
-
* @remarks
|
|
14539
|
-
* This fires an event.
|
|
14540
|
-
*/
|
|
14541
|
-
setAdjusting(range: IRangeSelection.Coords | null): void;
|
|
14542
|
-
/**
|
|
14543
|
-
* Returns the adjusting range.
|
|
14544
|
-
*/
|
|
14545
|
-
getAdjusting(): IRangeSelection.Coords | null;
|
|
14546
|
-
/**
|
|
14547
|
-
* Adds listeners to the selection.
|
|
14548
|
-
* @param listeners The listeners to add.
|
|
14549
|
-
* @param options Options for the listeners.
|
|
14550
|
-
* @returns A function to remove the listeners.
|
|
14551
|
-
*/
|
|
14552
|
-
addListeners(listeners: IRangeSelection.IListeners, options?: IListener.Options): IListener.Remove;
|
|
14553
|
-
}
|
|
14554
|
-
/**
|
|
14555
|
-
* {@inheritDoc IRangeSelection}
|
|
14556
|
-
* @see
|
|
14557
|
-
* ### **Interface**
|
|
14558
|
-
*
|
|
14559
|
-
* {@link IRangeSelection}
|
|
14560
|
-
*/
|
|
14561
|
-
export namespace IRangeSelection {
|
|
14562
|
-
/**
|
|
14563
|
-
* Represents a selection of ranges with an active range and an active cell.
|
|
14564
|
-
*/
|
|
14565
|
-
type Coords = WellKnownSelectionCoords;
|
|
14566
|
-
/**
|
|
14567
|
-
* Type representing different selection policies.
|
|
14568
|
-
*/
|
|
14569
|
-
type SelectionPolicy = 'single' | 'range' | 'multiple';
|
|
14570
|
-
/**
|
|
14571
|
-
* Type representing different new selection modes.
|
|
14572
|
-
*/
|
|
14573
|
-
type NewSelectionMode = 'clear' | 'modify' | 'append';
|
|
14574
|
-
/**
|
|
14575
|
-
* Events for {@link IRangeSelection}.
|
|
14576
|
-
*/
|
|
14577
|
-
interface Events {
|
|
14578
|
-
/**
|
|
14579
|
-
* Called when the selection changes.
|
|
14580
|
-
*
|
|
14581
|
-
* @param source The source of the event.
|
|
14582
|
-
*/
|
|
14583
|
-
onChange?(source: IRangeSelection): void;
|
|
14584
|
-
/**
|
|
14585
|
-
* Called when the selection is adjusting.
|
|
14586
|
-
*
|
|
14587
|
-
* @param source The source of the event.
|
|
14588
|
-
*/
|
|
14589
|
-
onAdjustingChange?(source: IRangeSelection): void;
|
|
14590
|
-
}
|
|
14591
|
-
/**
|
|
14592
|
-
* Listeners for IRangeSelection events.
|
|
14593
|
-
*/
|
|
14594
|
-
interface IListeners extends IListener.Callbacks<IRangeSelection, Events> {
|
|
14595
|
-
}
|
|
14596
|
-
/**
|
|
14597
|
-
* Options for constructing an IRangeSelection.
|
|
14598
|
-
*/
|
|
14599
|
-
interface ConstructorOptions {
|
|
14600
|
-
/**
|
|
14601
|
-
* The sheet to which the selection belongs.
|
|
14602
|
-
*/
|
|
14603
|
-
sheet: ISheet;
|
|
14604
|
-
/**
|
|
14605
|
-
* Selection policy.
|
|
14606
|
-
*/
|
|
14607
|
-
selectionPolicy?: IRangeSelection.SelectionPolicy;
|
|
14608
|
-
/**
|
|
14609
|
-
* New selection mode.
|
|
14610
|
-
*/
|
|
14611
|
-
newSelectionMode?: IRangeSelection.NewSelectionMode;
|
|
14612
|
-
}
|
|
14613
|
-
}
|
|
14614
|
-
}
|
|
14615
|
-
declare module "selection/index" {
|
|
14616
|
-
export * from "selection/IRangeSelection";
|
|
14617
|
-
}
|
|
14618
14460
|
declare module "protection/IProtection" {
|
|
14619
14461
|
import type { IListener } from "listener/index";
|
|
14620
14462
|
/**
|
|
@@ -15204,6 +15046,17 @@ declare module "workbook/IWorkbook" {
|
|
|
15204
15046
|
* * Does not fire a theme updated event.
|
|
15205
15047
|
*/
|
|
15206
15048
|
setTheme(theme: ITheme | null): ITheme;
|
|
15049
|
+
/**
|
|
15050
|
+
* Returns the display name for the workbook.
|
|
15051
|
+
*
|
|
15052
|
+
* @remarks
|
|
15053
|
+
* This may be null
|
|
15054
|
+
*/
|
|
15055
|
+
getName(): string | null;
|
|
15056
|
+
/**
|
|
15057
|
+
* Set the name for the workbook.
|
|
15058
|
+
*/
|
|
15059
|
+
setName(name: string | null): IWorkbook;
|
|
15207
15060
|
/**
|
|
15208
15061
|
* Is date resolution 1904 instead of 1900 based.
|
|
15209
15062
|
*
|
|
@@ -15365,6 +15218,10 @@ declare module "workbook/IWorkbook" {
|
|
|
15365
15218
|
* @param source {@link IWorkbook}
|
|
15366
15219
|
*/
|
|
15367
15220
|
onViewChange?(source: IWorkbook): void;
|
|
15221
|
+
/**
|
|
15222
|
+
* Called when the name changes.
|
|
15223
|
+
*/
|
|
15224
|
+
onNameChange?(source: IWorkbook): void;
|
|
15368
15225
|
/**
|
|
15369
15226
|
* Called when the scripts associated with the workbook have change.
|
|
15370
15227
|
*/
|
|
@@ -15469,6 +15326,21 @@ declare module "workbook/IWorkbook" {
|
|
|
15469
15326
|
* @defaultValue `Sheet${index+1}`
|
|
15470
15327
|
*/
|
|
15471
15328
|
createSheetNameCallback?: (index: number) => string;
|
|
15329
|
+
/**
|
|
15330
|
+
* The initial name for the workbook.
|
|
15331
|
+
*/
|
|
15332
|
+
name?: string | null;
|
|
15333
|
+
/**
|
|
15334
|
+
* Returns a valid name for the workbook.
|
|
15335
|
+
*
|
|
15336
|
+
* @param name The name to validate.
|
|
15337
|
+
* @returns The valid name. This may be different from the name provided.
|
|
15338
|
+
* @throws Error if the name is not valid.
|
|
15339
|
+
*
|
|
15340
|
+
* @remarks
|
|
15341
|
+
* This is not called if the name is null or for the initialName if provided.
|
|
15342
|
+
*/
|
|
15343
|
+
validateWorkbookName?: (name: string) => string | null | void;
|
|
15472
15344
|
/**
|
|
15473
15345
|
* A theme for the workbook.
|
|
15474
15346
|
*/
|
|
@@ -16358,6 +16230,228 @@ declare module "workbook/_WorkbookUtils" {
|
|
|
16358
16230
|
*/
|
|
16359
16231
|
export const findValidSheetName: (str: string, validate: (validating: string) => string) => string;
|
|
16360
16232
|
}
|
|
16233
|
+
declare module "selection/IRangeSelection" {
|
|
16234
|
+
import type { IRange } from '@sheetxl/primitives';
|
|
16235
|
+
import type { SelectionCoords as WellKnownSelectionCoords } from '@sheetxl/utils';
|
|
16236
|
+
import type { IListener } from "listener/index";
|
|
16237
|
+
import type { ISheet } from "sheet/index";
|
|
16238
|
+
/**
|
|
16239
|
+
* Interface representing a range selection within a sheet.
|
|
16240
|
+
*/
|
|
16241
|
+
export interface IRangeSelection {
|
|
16242
|
+
/**
|
|
16243
|
+
* Navigates the entire sheet
|
|
16244
|
+
*
|
|
16245
|
+
* @param direction The direction to navigate.
|
|
16246
|
+
* @param select Whether to select the cell after navigating.
|
|
16247
|
+
* @param contentful Whether to navigate to contentful cells only.
|
|
16248
|
+
* @param incrementAmount The amount to increment.
|
|
16249
|
+
* @returns The current instance.
|
|
16250
|
+
*/
|
|
16251
|
+
navigate(direction: IRange.Direction, select?: boolean, contentful?: boolean, incrementAmount?: number): this;
|
|
16252
|
+
/**
|
|
16253
|
+
* Checks if the entire range is selected.
|
|
16254
|
+
* @returns True if the entire range is selected, otherwise false.
|
|
16255
|
+
*/
|
|
16256
|
+
isEntire(): boolean;
|
|
16257
|
+
/**
|
|
16258
|
+
* Returns the coordinates of the selection.
|
|
16259
|
+
* @returns The selection coordinates.
|
|
16260
|
+
*/
|
|
16261
|
+
getCoords(): IRangeSelection.Coords;
|
|
16262
|
+
/**
|
|
16263
|
+
* Returns the selection as an array of IRange.Coords.
|
|
16264
|
+
*
|
|
16265
|
+
* @param coords Optional coordinates to convert. If not provided, uses the current selection.
|
|
16266
|
+
*
|
|
16267
|
+
* @remarks
|
|
16268
|
+
* The first element is always the active range.
|
|
16269
|
+
*/
|
|
16270
|
+
getRangesCoords(coords?: Partial<IRangeSelection.Coords>): IRange.Coords[];
|
|
16271
|
+
/**
|
|
16272
|
+
* Updates the selection coordinates.
|
|
16273
|
+
*
|
|
16274
|
+
* @param coords The new coordinates.
|
|
16275
|
+
* @returns The current instance.
|
|
16276
|
+
*/
|
|
16277
|
+
updateCoords(coords: IRangeSelection.Coords): this;
|
|
16278
|
+
/**
|
|
16279
|
+
* Traverses the selection, moving to the next cell based on the orientation.
|
|
16280
|
+
*
|
|
16281
|
+
* @param orientation The orientation to traverse. Default is `ICellRange.Orientation.Row`.
|
|
16282
|
+
* @param reverse Whether to traverse in reverse. Default is false.
|
|
16283
|
+
* @returns The current instance.
|
|
16284
|
+
* @remarks Useful for pressing tab or enter from the UI.
|
|
16285
|
+
*/
|
|
16286
|
+
traverse(orientation?: IRange.Orientation, reverse?: boolean): this;
|
|
16287
|
+
/**
|
|
16288
|
+
* Updates the selection using a new start and end.
|
|
16289
|
+
*
|
|
16290
|
+
* @param start The start cell.
|
|
16291
|
+
* @param end The end cell. Default is the start cell.
|
|
16292
|
+
* @param anchor The anchor cell.
|
|
16293
|
+
*/
|
|
16294
|
+
clearAndModify(start: Partial<IRange.CellCoords>, end?: Partial<IRange.CellCoords>, anchor?: Partial<IRange.CellCoords>): void;
|
|
16295
|
+
/**
|
|
16296
|
+
* Modifies the selection around the anchor.
|
|
16297
|
+
*
|
|
16298
|
+
* @param cellAnchor The anchor cell.
|
|
16299
|
+
* @param cellPivot The pivot cell.
|
|
16300
|
+
* @param resetAnchor Whether to reset the anchor. Default is false.
|
|
16301
|
+
*/
|
|
16302
|
+
modify(cellAnchor: Partial<IRange.CellCoords>, cellPivot?: Partial<IRange.CellCoords>, resetAnchor?: boolean): void;
|
|
16303
|
+
/**
|
|
16304
|
+
* Clears the range selections.
|
|
16305
|
+
*
|
|
16306
|
+
* @remarks This does not affect the cell.
|
|
16307
|
+
*/
|
|
16308
|
+
clear(): void;
|
|
16309
|
+
/**
|
|
16310
|
+
* Appends a selection to the current selection.
|
|
16311
|
+
*
|
|
16312
|
+
* @param start The start cell.
|
|
16313
|
+
* @param end The end cell. Default is the start cell.
|
|
16314
|
+
* @param anchor The anchor cell.
|
|
16315
|
+
* @remarks This is used to support the CMD key behavior in the UI.
|
|
16316
|
+
*/
|
|
16317
|
+
append(start: IRange.CellCoords, end?: IRange.CellCoords, anchor?: Partial<IRange.CellCoords>): void;
|
|
16318
|
+
/**
|
|
16319
|
+
* A special range used during drag.
|
|
16320
|
+
* @param range The range or null.
|
|
16321
|
+
*
|
|
16322
|
+
* @remarks
|
|
16323
|
+
* This fires an event.
|
|
16324
|
+
*/
|
|
16325
|
+
setAdjusting(range: IRangeSelection.Coords | null): void;
|
|
16326
|
+
/**
|
|
16327
|
+
* Returns the adjusting range.
|
|
16328
|
+
*/
|
|
16329
|
+
getAdjusting(): IRangeSelection.Coords | null;
|
|
16330
|
+
/**
|
|
16331
|
+
* Adds listeners to the selection.
|
|
16332
|
+
* @param listeners The listeners to add.
|
|
16333
|
+
* @param options Options for the listeners.
|
|
16334
|
+
* @returns A function to remove the listeners.
|
|
16335
|
+
*/
|
|
16336
|
+
addListeners(listeners: IRangeSelection.IListeners, options?: IListener.Options): IListener.Remove;
|
|
16337
|
+
}
|
|
16338
|
+
/**
|
|
16339
|
+
* {@inheritDoc IRangeSelection}
|
|
16340
|
+
* @see
|
|
16341
|
+
* ### **Interface**
|
|
16342
|
+
*
|
|
16343
|
+
* {@link IRangeSelection}
|
|
16344
|
+
*/
|
|
16345
|
+
export namespace IRangeSelection {
|
|
16346
|
+
/**
|
|
16347
|
+
* Represents a selection of ranges with an active range and an active cell.
|
|
16348
|
+
*/
|
|
16349
|
+
type Coords = WellKnownSelectionCoords;
|
|
16350
|
+
/**
|
|
16351
|
+
* Type representing different selection policies.
|
|
16352
|
+
*/
|
|
16353
|
+
type SelectionPolicy = 'single' | 'range' | 'multiple';
|
|
16354
|
+
/**
|
|
16355
|
+
* Type representing different new selection modes.
|
|
16356
|
+
*/
|
|
16357
|
+
type NewSelectionMode = 'clear' | 'modify' | 'append';
|
|
16358
|
+
/**
|
|
16359
|
+
* Events for {@link IRangeSelection}.
|
|
16360
|
+
*/
|
|
16361
|
+
interface Events {
|
|
16362
|
+
/**
|
|
16363
|
+
* Called when the selection changes.
|
|
16364
|
+
*
|
|
16365
|
+
* @param source The source of the event.
|
|
16366
|
+
*/
|
|
16367
|
+
onChange?(source: IRangeSelection): void;
|
|
16368
|
+
/**
|
|
16369
|
+
* Called when the selection is adjusting.
|
|
16370
|
+
*
|
|
16371
|
+
* @param source The source of the event.
|
|
16372
|
+
*/
|
|
16373
|
+
onAdjustingChange?(source: IRangeSelection): void;
|
|
16374
|
+
}
|
|
16375
|
+
/**
|
|
16376
|
+
* Listeners for IRangeSelection events.
|
|
16377
|
+
*/
|
|
16378
|
+
interface IListeners extends IListener.Callbacks<IRangeSelection, Events> {
|
|
16379
|
+
}
|
|
16380
|
+
/**
|
|
16381
|
+
* Options for constructing an IRangeSelection.
|
|
16382
|
+
*/
|
|
16383
|
+
interface ConstructorOptions {
|
|
16384
|
+
/**
|
|
16385
|
+
* The sheet to which the selection belongs.
|
|
16386
|
+
*/
|
|
16387
|
+
sheet: ISheet;
|
|
16388
|
+
/**
|
|
16389
|
+
* Selection policy.
|
|
16390
|
+
*/
|
|
16391
|
+
selectionPolicy?: IRangeSelection.SelectionPolicy;
|
|
16392
|
+
/**
|
|
16393
|
+
* New selection mode.
|
|
16394
|
+
*/
|
|
16395
|
+
newSelectionMode?: IRangeSelection.NewSelectionMode;
|
|
16396
|
+
}
|
|
16397
|
+
}
|
|
16398
|
+
}
|
|
16399
|
+
declare module "selection/_RangeSelectionUtils" {
|
|
16400
|
+
import { IRange } from '@sheetxl/primitives';
|
|
16401
|
+
import { IRangeSelection } from "selection/IRangeSelection";
|
|
16402
|
+
/**
|
|
16403
|
+
* Scans until finds a visible (non hidden) header.
|
|
16404
|
+
*
|
|
16405
|
+
* @param hiddenAt Callback
|
|
16406
|
+
* @param index The index to start from
|
|
16407
|
+
* @param direction The direction to scan
|
|
16408
|
+
*/
|
|
16409
|
+
export const traverseHiddenHeaders: (hiddenAt: HiddenHeadersAt | undefined, index: number, direction: IRange.Direction) => number;
|
|
16410
|
+
export const getVisibleHeaders: (hiddenAt: HiddenHeadersAt | undefined, startIndex: number, stopIndex: number) => number[];
|
|
16411
|
+
export const EmptyCell: IRange.CellCoords;
|
|
16412
|
+
export const EmptyRanges: IRange.Coords[];
|
|
16413
|
+
/**
|
|
16414
|
+
* Frozen IRangeSelection.Coords for easy comparisons.
|
|
16415
|
+
*/
|
|
16416
|
+
export const EmptySelection: IRangeSelection.Coords;
|
|
16417
|
+
export const mergeSelection: (selection: IRangeSelection.Coords, activeSelection: IRangeSelection.Coords, maxRangeCoords: IRange.Coords) => IRangeSelection.Coords;
|
|
16418
|
+
/**
|
|
16419
|
+
* Cycles active cell within selection range. This has slightly different semantics than regular traversal
|
|
16420
|
+
* * wraps
|
|
16421
|
+
* * visits each cell once (skipping merged cells after first step)
|
|
16422
|
+
* * jumps to next range if multiple ranges are selected
|
|
16423
|
+
*
|
|
16424
|
+
* @param selection
|
|
16425
|
+
* @param direction
|
|
16426
|
+
*/
|
|
16427
|
+
export const findNextCellWithinSelection: (selection: IRangeSelection.Coords, direction: IRange.Direction, getCellCoordsAsRangeCoords: (coords: IRange.CellCoords) => IRange.Coords, hiddenRowsAt?: HiddenHeadersAt, hiddenColumnsAt?: HiddenHeadersAt, originalSelection?: IRangeSelection.Coords) => IRangeSelection.Coords | null;
|
|
16428
|
+
export interface HiddenHeadersAt {
|
|
16429
|
+
/**
|
|
16430
|
+
* A called back to traverse hidden headers
|
|
16431
|
+
*/
|
|
16432
|
+
(index: number, reverse?: boolean): number;
|
|
16433
|
+
}
|
|
16434
|
+
export interface IsContentfulCell {
|
|
16435
|
+
(coords: IRange.CellCoords): boolean;
|
|
16436
|
+
}
|
|
16437
|
+
export type CellFinder = (activeCoords: IRange.CellCoords, isContentfulCell: IsContentfulCell | undefined, hiddenAt: HiddenHeadersAt | undefined, direction: IRange.Direction, first: boolean, limit: number) => number;
|
|
16438
|
+
/**
|
|
16439
|
+
* Returns the cells as an ordered list of ranges. The first range is the active range.
|
|
16440
|
+
* If there are no ranges then the active coord will be returns as a range.
|
|
16441
|
+
*
|
|
16442
|
+
* @remarks
|
|
16443
|
+
* * Always return at least 1 range unless the selection is null.
|
|
16444
|
+
*/
|
|
16445
|
+
export const selectionToRangesCoords: (selection: Partial<IRangeSelection.Coords>) => IRange.Coords[];
|
|
16446
|
+
/**
|
|
16447
|
+
* Creates a IRangeSelection.Coords from an array of ranges.
|
|
16448
|
+
*
|
|
16449
|
+
* @param ranges The ranges to include in the selection.
|
|
16450
|
+
* @param cell If provided will try to fit within the cell
|
|
16451
|
+
* @param rangeIndex *default* `ranges.length 1 unless this is a single cell then -1`.
|
|
16452
|
+
*/
|
|
16453
|
+
export const rangesToSelectionCoords: (ranges: readonly IRange.Coords[], cell?: IRange.CellCoords, rangeIndex?: number) => IRangeSelection.Coords;
|
|
16454
|
+
}
|
|
16361
16455
|
declare module "lib/utils/_Utils" {
|
|
16362
16456
|
export const getBuildVersion: () => string;
|
|
16363
16457
|
export const getBuildDate: () => string;
|
|
@@ -16451,6 +16545,7 @@ declare module "license/LicenseManager" {
|
|
|
16451
16545
|
private _validate;
|
|
16452
16546
|
private _printBanner;
|
|
16453
16547
|
private _printDetails;
|
|
16548
|
+
private _doPrint;
|
|
16454
16549
|
private _print;
|
|
16455
16550
|
getDetails(): Promise<LicenseDetails>;
|
|
16456
16551
|
/**
|
|
@@ -18327,6 +18422,9 @@ declare module "movable/CustomElement" {
|
|
|
18327
18422
|
}
|
|
18328
18423
|
}
|
|
18329
18424
|
}
|
|
18425
|
+
declare module "selection/index" {
|
|
18426
|
+
export * from "selection/IRangeSelection";
|
|
18427
|
+
}
|
|
18330
18428
|
declare module "conditional/IConditionalFormatCollection" {
|
|
18331
18429
|
import type { ICellRange, ICellRanges } from "cellRange/index";
|
|
18332
18430
|
import type { ICollection } from "type/index";
|
|
@@ -18973,53 +19071,6 @@ declare module "address/index" {
|
|
|
18973
19071
|
const resolveRelativeToA1: (tokens: (string | IRange.CellCoords)[], rowIndex: number, colIndex: number) => string;
|
|
18974
19072
|
}
|
|
18975
19073
|
}
|
|
18976
|
-
declare module "selection/_RangeSelectionUtils" {
|
|
18977
|
-
import { IRange } from '@sheetxl/primitives';
|
|
18978
|
-
import { IRangeSelection } from "selection/IRangeSelection";
|
|
18979
|
-
/**
|
|
18980
|
-
* Scans until finds a visible (non hidden) header.
|
|
18981
|
-
*
|
|
18982
|
-
* @param hiddenAt Callback
|
|
18983
|
-
* @param index The index to start from
|
|
18984
|
-
* @param direction The direction to scan
|
|
18985
|
-
*/
|
|
18986
|
-
export const traverseHiddenHeaders: (hiddenAt: HiddenHeadersAt | undefined, index: number, direction: IRange.Direction) => number;
|
|
18987
|
-
export const getVisibleHeaders: (hiddenAt: HiddenHeadersAt | undefined, startIndex: number, stopIndex: number) => number[];
|
|
18988
|
-
export const EmptyCell: IRange.CellCoords;
|
|
18989
|
-
export const EmptyRanges: IRange.Coords[];
|
|
18990
|
-
/**
|
|
18991
|
-
* Frozen IRangeSelection.Coords for easy comparisons.
|
|
18992
|
-
*/
|
|
18993
|
-
export const EmptySelection: IRangeSelection.Coords;
|
|
18994
|
-
export const mergeSelection: (selection: IRangeSelection.Coords, activeSelection: IRangeSelection.Coords, maxRangeCoords: IRange.Coords) => IRangeSelection.Coords;
|
|
18995
|
-
/**
|
|
18996
|
-
* Cycles active cell within selection range. This has slightly different semantics than regular traversal
|
|
18997
|
-
* * wraps
|
|
18998
|
-
* * visits each cell once (skipping merged cells after first step)
|
|
18999
|
-
* * jumps to next range if multiple ranges are selected
|
|
19000
|
-
*
|
|
19001
|
-
* @param selection
|
|
19002
|
-
* @param direction
|
|
19003
|
-
*/
|
|
19004
|
-
export const findNextCellWithinSelection: (selection: IRangeSelection.Coords, direction: IRange.Direction, getCellCoordsAsRangeCoords: (coords: IRange.CellCoords) => IRange.Coords, hiddenRowsAt?: HiddenHeadersAt, hiddenColumnsAt?: HiddenHeadersAt, originalSelection?: IRangeSelection.Coords) => IRangeSelection.Coords | null;
|
|
19005
|
-
export interface HiddenHeadersAt {
|
|
19006
|
-
/**
|
|
19007
|
-
* A called back to traverse hidden headers
|
|
19008
|
-
*/
|
|
19009
|
-
(index: number, reverse?: boolean): number;
|
|
19010
|
-
}
|
|
19011
|
-
export interface IsContentfulCell {
|
|
19012
|
-
(coords: IRange.CellCoords): boolean;
|
|
19013
|
-
}
|
|
19014
|
-
export type CellFinder = (activeCoords: IRange.CellCoords, isContentfulCell: IsContentfulCell | undefined, hiddenAt: HiddenHeadersAt | undefined, direction: IRange.Direction, first: boolean, limit: number) => number;
|
|
19015
|
-
/**
|
|
19016
|
-
* Returns the cells as an ordered list of ranges. The first range is the active range.
|
|
19017
|
-
* If there are no ranges then the active coord will be returns as a range.
|
|
19018
|
-
* @remarks
|
|
19019
|
-
* * Always return at least 1 range unless the selection is null.
|
|
19020
|
-
*/
|
|
19021
|
-
export const selectionToRanges: (selection: Partial<IRangeSelection.Coords>) => IRange.Coords[];
|
|
19022
|
-
}
|
|
19023
19074
|
declare module "selection/RangeSelection" {
|
|
19024
19075
|
import { IRange } from '@sheetxl/primitives';
|
|
19025
19076
|
import { IListener } from "listener/index";
|
|
@@ -21980,7 +22031,7 @@ declare module "calculation/graph/_CalcGraphUtils" {
|
|
|
21980
22031
|
}
|
|
21981
22032
|
declare module "sheet/Sheet" {
|
|
21982
22033
|
import { Scalar, JSScalar, IRange } from '@sheetxl/primitives';
|
|
21983
|
-
import { Size, type Bounds, CoordUtils } from '@sheetxl/utils';
|
|
22034
|
+
import { type Size, type Bounds, CoordUtils } from '@sheetxl/utils';
|
|
21984
22035
|
import { ITypes, ICollection, IProperties } from "type/index";
|
|
21985
22036
|
import type { IWorkbook } from "workbook/index";
|
|
21986
22037
|
import type { IListener } from "listener/index";
|
|
@@ -22374,9 +22425,7 @@ declare module "sheet/Sheet" {
|
|
|
22374
22425
|
/** @internal */
|
|
22375
22426
|
protected _realizeCalcedValues(results: ICalcGraph.Results): void;
|
|
22376
22427
|
/** @internal */
|
|
22377
|
-
protected _calculate(ranges: ICellRanges.Coords, options?:
|
|
22378
|
-
/** @internal */
|
|
22379
|
-
protected _waitForCalcs(): Promise<void>;
|
|
22428
|
+
protected _calculate(ranges: ICellRanges.Coords, options?: ICalculation.CalculateOptions): void;
|
|
22380
22429
|
/** @internal */
|
|
22381
22430
|
protected _calculateFull(): void;
|
|
22382
22431
|
/** @internal */
|
|
@@ -22481,6 +22530,8 @@ declare module "sheet/Sheet" {
|
|
|
22481
22530
|
/** {@inheritDoc ISheet.find} */
|
|
22482
22531
|
find(options?: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22483
22532
|
/** @internal */
|
|
22533
|
+
protected _setMaxSize(size: Partial<Size> | null, options?: ITransaction.OperationOptions): this;
|
|
22534
|
+
/** @internal */
|
|
22484
22535
|
protected _find(ranges: readonly IRange.Coords[], options: string | ICellRange.FindOptions): Iterator<ICell>;
|
|
22485
22536
|
/** {@inheritDoc ISheet.isDate1904} */
|
|
22486
22537
|
isDate1904(): boolean;
|
|
@@ -22720,8 +22771,6 @@ declare module "sheet/SheetRange" {
|
|
|
22720
22771
|
getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
|
|
22721
22772
|
/** {@inheritDoc ICellRange.calculate} */
|
|
22722
22773
|
calculate(full: boolean): this;
|
|
22723
|
-
/** {@inheritDoc ICellRange.waitForCalcs} */
|
|
22724
|
-
waitForCalcs(): Promise<this>;
|
|
22725
22774
|
/** {@inheritDoc ICellRange.getCells} */
|
|
22726
22775
|
getCells(options?: ICellRange.GetValuesOptions): ICell[][];
|
|
22727
22776
|
/** {@inheritDoc ICellRange.getCell} */
|
|
@@ -22959,6 +23008,7 @@ declare module "workbook/Workbook" {
|
|
|
22959
23008
|
lastId: number;
|
|
22960
23009
|
sheetsCreated: Set<ISheet>;
|
|
22961
23010
|
listenersSheets: Map<number, IListener.Remove>;
|
|
23011
|
+
name: string | null;
|
|
22962
23012
|
}
|
|
22963
23013
|
interface InternalCreateSheet {
|
|
22964
23014
|
(
|
|
@@ -23023,6 +23073,10 @@ declare module "workbook/Workbook" {
|
|
|
23023
23073
|
protected _isDate1904: boolean;
|
|
23024
23074
|
constructor(options?: IWorkbook.ConstructorOptions);
|
|
23025
23075
|
protected _initState(): void;
|
|
23076
|
+
/** {@inheritDoc IWorkbook.getName} */
|
|
23077
|
+
getName(): string | null;
|
|
23078
|
+
/** {@inheritDoc IWorkbook.setName} */
|
|
23079
|
+
setName(name: string | null): IWorkbook;
|
|
23026
23080
|
/** {@inheritDoc IWorkbook.getView} */
|
|
23027
23081
|
getView(): IWorkbookView;
|
|
23028
23082
|
/** {@inheritDoc IWorkbook.setView} */
|
|
@@ -23780,7 +23834,7 @@ declare module "sheet/ISheet" {
|
|
|
23780
23834
|
* Returns the {@link IWorkbook} for the sheet.
|
|
23781
23835
|
*
|
|
23782
23836
|
* @remarks
|
|
23783
|
-
* This may be null if not created via a workbook
|
|
23837
|
+
* This may be `null` if not created via a workbook.
|
|
23784
23838
|
*/
|
|
23785
23839
|
getWorkbook(): IWorkbook | null;
|
|
23786
23840
|
/**
|
|
@@ -24479,7 +24533,6 @@ declare module "sheet/_SheetUtils" {
|
|
|
24479
24533
|
import { ITypes } from "type/index";
|
|
24480
24534
|
import type { IStringCollection } from "string/index";
|
|
24481
24535
|
import { ISort } from "sort/index";
|
|
24482
|
-
import type { IRangeSelection } from "selection/index";
|
|
24483
24536
|
import { type IStyle } from "style/index";
|
|
24484
24537
|
import type { ICell, ICellHeader } from "cell/index";
|
|
24485
24538
|
import type { ICellRange } from "cellRange/index";
|
|
@@ -24637,22 +24690,6 @@ declare module "sheet/_SheetUtils" {
|
|
|
24637
24690
|
* Expands ranges to include merges.
|
|
24638
24691
|
*/
|
|
24639
24692
|
export const expandToIncludeMerges: (ranges: readonly IRange.Coords[], mergeSpatial: ISpatialMap<MergeEntry>, entireCoords: IRange.Coords) => IRange.Coords[];
|
|
24640
|
-
/**
|
|
24641
|
-
* Creates a IRangeSelection.Coords from an array of ranges.
|
|
24642
|
-
*
|
|
24643
|
-
* @param ranges
|
|
24644
|
-
* @param cell if provided will try to fit within the cell
|
|
24645
|
-
* @param rangeIndex *default* `ranges.length 1 unless this is a single cell then -1`.
|
|
24646
|
-
*/
|
|
24647
|
-
export const toRangeSelectionCoords: (ranges: readonly IRange.Coords[], cell?: IRange.CellCoords, rangeIndex?: number) => IRangeSelection.Coords;
|
|
24648
|
-
/**
|
|
24649
|
-
* Creates a IRangeSelection.Coords from an array of ranges.
|
|
24650
|
-
*
|
|
24651
|
-
* @param ranges
|
|
24652
|
-
* @param rangeIndex @defaultValue ranges.length 1 unless this is a single cell then -1
|
|
24653
|
-
* @deprecated use toRangeSelectionCoords
|
|
24654
|
-
*/
|
|
24655
|
-
export const rangesToSelection: (ranges: readonly IRange.Coords[], rangeIndex?: number) => IRangeSelection.Coords;
|
|
24656
24693
|
export type OrientedStyled = {
|
|
24657
24694
|
orientations: IRange.Orientations;
|
|
24658
24695
|
index: number;
|
|
@@ -25220,7 +25257,7 @@ declare module "calculation/graph/ICalcGraph" {
|
|
|
25220
25257
|
* @remarks
|
|
25221
25258
|
* For async functions this will return before they are completed.
|
|
25222
25259
|
*/
|
|
25223
|
-
calculate(options?:
|
|
25260
|
+
calculate(options?: ICalculation.CalculateOptions | boolean): Promise<ICalcGraph.Results>;
|
|
25224
25261
|
/**
|
|
25225
25262
|
* The the value at a specific cell to a formula.
|
|
25226
25263
|
*
|
|
@@ -25561,23 +25598,6 @@ declare module "calculation/graph/ICalcGraph" {
|
|
|
25561
25598
|
*/
|
|
25562
25599
|
isEquals(other: ICalcGraph.IFormulaBlock): boolean;
|
|
25563
25600
|
}
|
|
25564
|
-
/**
|
|
25565
|
-
* Options for when calculating.
|
|
25566
|
-
*/
|
|
25567
|
-
interface CalculateOptions {
|
|
25568
|
-
/**
|
|
25569
|
-
* If true a full calc will be done not just invalid values
|
|
25570
|
-
*/
|
|
25571
|
-
full?: boolean;
|
|
25572
|
-
/**
|
|
25573
|
-
* If true the the promise will not result until all pending calculations are complete.
|
|
25574
|
-
*
|
|
25575
|
-
* @remarks
|
|
25576
|
-
* * Useful when wanting all results for a calculation such as a rest API call.
|
|
25577
|
-
* * Streaming functions will return the first value and immediately unsubscribe.
|
|
25578
|
-
*/
|
|
25579
|
-
waitForPending?: boolean;
|
|
25580
|
-
}
|
|
25581
25601
|
/**
|
|
25582
25602
|
* Options for shifting the calc graph.
|
|
25583
25603
|
*/
|
|
@@ -25792,6 +25812,7 @@ declare module "calculation/graph/CalcGraph" {
|
|
|
25792
25812
|
graph: CalcGraph;
|
|
25793
25813
|
};
|
|
25794
25814
|
_iterationId: number;
|
|
25815
|
+
_uuid: string;
|
|
25795
25816
|
_options: ICalcGraph.ConstructorOptions;
|
|
25796
25817
|
_getEntireCoords: () => IRange.Coords;
|
|
25797
25818
|
_calculation: ICalculation;
|
|
@@ -25849,7 +25870,7 @@ declare module "calculation/graph/CalcGraph" {
|
|
|
25849
25870
|
/** {@inheritDoc ICalcGraph.autoFill} */
|
|
25850
25871
|
autoFill(template: IRange.Coords | string, destination: IRange.Coords | string): this;
|
|
25851
25872
|
protected _scheduleRecalculation(nodes?: CalcNode | CalcNode[]): void;
|
|
25852
|
-
protected _notifyCalculated(options:
|
|
25873
|
+
protected _notifyCalculated(options: ICalculation.CalculateOptions | boolean): Promise<ICalcGraph.Results>;
|
|
25853
25874
|
_setInputs(values: Tuple.BoundedTuples<Scalar>, formulas: readonly ISpatialMap.Entry<string>[], deleteRange?: IRange.Coords): ISpatialMap.Updates<ICalcGraph.FormulaInsert>;
|
|
25854
25875
|
protected _invalidate(invalidations: ISpatialMap.Entry[]): void;
|
|
25855
25876
|
/**
|
|
@@ -25870,7 +25891,7 @@ declare module "calculation/graph/CalcGraph" {
|
|
|
25870
25891
|
protected _markAndPlan(isFullCalc: boolean, initial: CalcNode[], markId: number): MarkResults;
|
|
25871
25892
|
protected _evaluate(forceFull: boolean): EvalResults;
|
|
25872
25893
|
/** {@inheritDoc ICalcGraph.calculate} */
|
|
25873
|
-
calculate(options?:
|
|
25894
|
+
calculate(options?: ICalculation.CalculateOptions | boolean): Promise<ICalcGraph.Results>;
|
|
25874
25895
|
protected _clearScope(): void;
|
|
25875
25896
|
protected _resetScope(): ICalcGraphScope;
|
|
25876
25897
|
/**
|
|
@@ -27193,7 +27214,7 @@ declare module ".generated/formulas/impl/financial/Financial" {
|
|
|
27193
27214
|
rate: number, pr: number, basis?: number): number;
|
|
27194
27215
|
}
|
|
27195
27216
|
declare module ".generated/formulas/impl/information/Information" {
|
|
27196
|
-
import {
|
|
27217
|
+
import { FormulaError, type Scalar, type IReferenceRange, type IRange } from '@sheetxl/primitives';
|
|
27197
27218
|
/**
|
|
27198
27219
|
* @summary Returns information about the cell.
|
|
27199
27220
|
* @param {'address' | 'col' | 'contents' | 'row' | 'type'} infoType The type of information to return.
|
|
@@ -29910,6 +29931,8 @@ declare module "calculation/Calculation" {
|
|
|
29910
29931
|
export class Calculation extends AbstractModel<State, ICalculation.JSON, CommitView, ICalculation.IListeners> implements ICalculation {
|
|
29911
29932
|
protected _context: CalculationContext;
|
|
29912
29933
|
protected _scope: ICalcGraphScope;
|
|
29934
|
+
protected _graphsCalcing: Map<string, ICalcGraph>;
|
|
29935
|
+
protected _graphsAll: Map<string, ICalcGraph>;
|
|
29913
29936
|
protected _functions: IFunctionCollection;
|
|
29914
29937
|
protected _runtime: IRuntime;
|
|
29915
29938
|
protected _formulaParser: IFormulaParser;
|
|
@@ -29919,6 +29942,8 @@ declare module "calculation/Calculation" {
|
|
|
29919
29942
|
constructor(options?: Calculation.ConstructorOptions);
|
|
29920
29943
|
protected _getContext(): CalculationContext;
|
|
29921
29944
|
protected _getScope(): ICalcGraphScope;
|
|
29945
|
+
protected _getCalcingGraphs(): Map<string, ICalcGraph>;
|
|
29946
|
+
protected _getAllGraphs(): Map<string, ICalcGraph>;
|
|
29922
29947
|
/** @inheritdoc ICalculation.start */
|
|
29923
29948
|
start(): Promise<void>;
|
|
29924
29949
|
protected _createGraph(options: ICalcGraph.ConstructorOptions): ICalcGraph;
|
|
@@ -29926,8 +29951,8 @@ declare module "calculation/Calculation" {
|
|
|
29926
29951
|
stop(): Promise<void>;
|
|
29927
29952
|
/** @inheritdoc ICalculation.getStatus */
|
|
29928
29953
|
getStatus(): ICalculation.Status;
|
|
29929
|
-
/** @inheritdoc ICalculation.
|
|
29930
|
-
|
|
29954
|
+
/** @inheritdoc ICalculation.calculate */
|
|
29955
|
+
calculate(options?: ICalculation.CalculateOptions): Promise<void>;
|
|
29931
29956
|
/** @inheritdoc ICalculation.getFunctions */
|
|
29932
29957
|
getFunctions(): IFunctionCollection;
|
|
29933
29958
|
/** @inheritdoc IFormulaContext.getRuntime */
|
|
@@ -32795,13 +32820,6 @@ declare module "cellRange/ICellRange" {
|
|
|
32795
32820
|
* @param full If `true` then all formulas will be recalculated.
|
|
32796
32821
|
*/
|
|
32797
32822
|
calculate(full?: boolean): this;
|
|
32798
|
-
/**
|
|
32799
|
-
* Waits for all calculations to finish.
|
|
32800
|
-
*
|
|
32801
|
-
* @remarks
|
|
32802
|
-
* Useful for ensuring that all calculations are complete before proceeding.
|
|
32803
|
-
*/
|
|
32804
|
-
waitForCalcs(): Promise<this>;
|
|
32805
32823
|
/**
|
|
32806
32824
|
* Fill the range to a destination using an array of {@link IAutoFill.Filler}.
|
|
32807
32825
|
*
|