@sheetxl/sdk 0.8.0-beta.1 → 0.8.0-beta.3
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/THIRD-PARTY-NOTICES.md +1 -1
- package/browser/cjs/B0AS8k-hrSCBUlUY.cjs +1 -0
- package/browser/cjs/B308aXzcAYr1GN1c.cjs +1 -0
- package/browser/cjs/B44p8LIyxG3GtaGC.cjs +93 -0
- package/browser/cjs/{a0Z-SXs_N71CtqYb.cjs → D6YaqporVrSewZpm.cjs} +1 -1
- package/browser/cjs/DjWcveVCs0NFiKep.cjs +1 -0
- package/browser/cjs/index.cjs +2 -2
- package/browser/esm/-OKDZ9cUBtkgD4Zr.mjs +20 -0
- package/browser/esm/8Nw0lKc4ISs7hEJT.mjs +70223 -0
- package/browser/esm/{DlPMeIyxT9tG_WDk.mjs → BmEEyMxNzlbXG98H.mjs} +2 -2
- package/browser/esm/BtdDRkWn-zCV3oic.mjs +394 -0
- package/browser/esm/DaCTT4vda0m8Fnxo.mjs +8 -0
- package/browser/esm/{B0HS42a7lga1k1U_.mjs → DvFKKE72ZA02l8iF.mjs} +1 -1
- package/browser/esm/{uyWBMSIxMlt8n5Z3.mjs → Z-dzbKvqaxll9l_t.mjs} +2 -2
- package/browser/esm/index.mjs +871 -696
- package/licenses/dependencies.txt +204 -204
- package/node/esm/{Cku7XiUvw1xrRasi.mjs → BpMTlTrJLWh_wJ5H.mjs} +1 -1
- package/node/esm/D5quDVovf1zjYBgJ.mjs +28 -0
- package/node/esm/DP0M3_S_dwLwRMiA.mjs +403 -0
- package/node/esm/DTHN_EkuOscW3f3B.mjs +8 -0
- package/node/esm/index.mjs +54375 -39377
- package/package.json +6 -7
- package/resources/locales/de/model.msg.json +45 -9
- package/resources/locales/en/model.msg.json +42 -9
- package/types/scripting-api.json +7094 -0
- package/types/scripting-enums.json +54 -8
- package/types/scripting.d.ts +6985 -1171
- package/types/src/anchored/AbstractAnchored.d.ts +18 -8
- package/types/src/anchored/AnchoredMap.d.ts +2 -0
- package/types/src/anchored/IAnchoredMap.d.ts +52 -4
- package/types/src/autoFill/AutoFill.d.ts +316 -32
- package/types/src/autoFill/IAutoFill.d.ts +232 -15
- package/types/src/border/{IBorder.d.ts → IBorders.d.ts} +41 -40
- package/types/src/border/index.d.ts +1 -1
- package/types/src/calculation/Calculation.d.ts +740 -35
- package/types/src/calculation/ExternalBookBindings.d.ts +118 -0
- package/types/src/calculation/FormulaText.d.ts +74 -0
- package/types/src/calculation/ICalculation.d.ts +318 -81
- package/types/src/calculation/INamedFormulasCollection.d.ts +5 -8
- package/types/src/calculation/NamedFormulaCollection.d.ts +139 -107
- package/types/src/calculation/NamedLambdaFunction.d.ts +28 -0
- package/types/src/calculation/TokenType.d.ts +9 -0
- package/types/src/calculation/Types.d.ts +83 -2
- package/types/src/calculation/_CloneBoundary.d.ts +80 -0
- package/types/src/calculation/compiler/ASTTypes.d.ts +58 -0
- package/types/src/calculation/compiler/CompilerUtils.d.ts +134 -12
- package/types/src/calculation/compiler/FormulaCompiler.d.ts +29 -4
- package/types/src/calculation/compiler/FormulaParser.d.ts +1 -2
- package/types/src/calculation/compiler/LiteTransform.d.ts +17 -0
- package/types/src/calculation/compiler/ParserUtils.d.ts +26 -1
- package/types/src/calculation/compiler/SRParser.d.ts +2 -1
- package/types/src/calculation/compiler/Types.d.ts +79 -9
- package/types/src/calculation/executor/CalcExecutor.d.ts +312 -33
- package/types/src/calculation/executor/CalcExecutorUtils.d.ts +43 -2
- package/types/src/calculation/executor/CircularReference.d.ts +2 -0
- package/types/src/calculation/formula/Formula.d.ts +58 -21
- package/types/src/calculation/formula/FormulaBlock.d.ts +124 -21
- package/types/src/calculation/formula/FormulaRecordView.d.ts +79 -0
- package/types/src/calculation/formula/IFormulaBlock.d.ts +261 -67
- package/types/src/calculation/formula/LambdaValue.d.ts +15 -16
- package/types/src/calculation/formula/LazyValue.d.ts +96 -0
- package/types/src/calculation/formula/TokenUtils.d.ts +25 -1
- package/types/src/calculation/formula/index.d.ts +1 -0
- package/types/src/calculation/functions/FunctionDeclarations.d.ts +31 -0
- package/types/src/calculation/functions/initializeFunctions.d.ts +15 -2
- package/types/src/calculation/grid/CalcGrid.d.ts +384 -158
- package/types/src/calculation/grid/CalcGridBackend.d.ts +450 -0
- package/types/src/calculation/grid/CalcGridProxy.d.ts +133 -0
- package/types/src/calculation/grid/CalcGridUtils.d.ts +62 -12
- package/types/src/calculation/grid/FormulaEntry.d.ts +129 -0
- package/types/src/calculation/grid/FormulaHost.d.ts +236 -0
- package/types/src/calculation/grid/ICalcGrid.d.ts +456 -143
- package/types/src/calculation/grid/_CalcRequest.d.ts +272 -0
- package/types/src/calculation/grid/index.d.ts +4 -0
- package/types/src/calculation/index.d.ts +2 -0
- package/types/src/calculation/spatial/ContentfulSpatialValue.d.ts +6 -2
- package/types/src/calculation/spatial/FormulaSpatialValue.d.ts +339 -11
- package/types/src/calculation/spatial/SpillEntry.d.ts +20 -5
- package/types/src/calculation/spatial/TouchedWindows.d.ts +86 -0
- package/types/src/calculation/spatial/index.d.ts +1 -0
- package/types/src/calculation/state/CalcInputs.d.ts +41 -0
- package/types/src/calculation/state/CalcNode.d.ts +141 -30
- package/types/src/calculation/state/CalcScope.d.ts +37 -0
- package/types/src/calculation/state/CalcState.d.ts +22 -1
- package/types/src/calculation/state/CalculationContext.d.ts +36 -2
- package/types/src/calculation/state/IContextContainer.d.ts +129 -27
- package/types/src/calculation/state/_PendingOverlayGrid.d.ts +163 -0
- package/types/src/calculation/state/_ReadObservedGrid.d.ts +74 -8
- package/types/src/calculation/state/index.d.ts +1 -0
- package/types/src/calculation/symbol/ExternalSheetSymbols.d.ts +80 -0
- package/types/src/calculation/symbol/ISymbolRegistry.d.ts +23 -0
- package/types/src/calculation/symbol/IndirectSymbolProvider.d.ts +16 -2
- package/types/src/calculation/symbol/SheetSymbolProvider.d.ts +63 -3
- package/types/src/calculation/symbol/SymbolRegistry.d.ts +20 -0
- package/types/src/calculation/symbol/index.d.ts +3 -2
- package/types/src/cell/ICell.d.ts +78 -23
- package/types/src/cell/ICellProtection.d.ts +50 -10
- package/types/src/cellRange/ICellRange.d.ts +329 -72
- package/types/src/cellRange/ICellRanges.d.ts +9 -7
- package/types/src/chart/Chart.d.ts +72 -2
- package/types/src/chart/ChartCollection.d.ts +26 -0
- package/types/src/chart/IChart.d.ts +162 -9
- package/types/src/chart/IChartCollection.d.ts +25 -0
- package/types/src/chart/_ChartXml.d.ts +70 -0
- package/types/src/chart/index.d.ts +1 -3
- package/types/src/collections/ArraysGrid.d.ts +1 -1
- package/types/src/collections/IGrid.d.ts +1 -1
- package/types/src/collections/ISparseGrid.d.ts +9 -0
- package/types/src/collections/ISpatialMap.d.ts +59 -21
- package/types/src/collections/ImmutableList.d.ts +28 -0
- package/types/src/collections/MixedTypedArrayList.d.ts +168 -108
- package/types/src/collections/OverlappingRangeIterator.d.ts +13 -17
- package/types/src/collections/RepeatingList.d.ts +7 -0
- package/types/src/collections/ScalarGrid.d.ts +50 -0
- package/types/src/collections/SparseGrid.d.ts +1 -1
- package/types/src/collections/SpatialMap.d.ts +13 -21
- package/types/src/collections/Tuple.d.ts +128 -16
- package/types/src/collections/_GridUtils.d.ts +19 -6
- package/types/src/collections/_RangeSweep.d.ts +97 -0
- package/types/src/collections/_SpatialUtils.d.ts +20 -2
- package/types/src/collections/index.d.ts +1 -0
- package/types/src/comment/Comment.d.ts +159 -0
- package/types/src/comment/CommentCollection.d.ts +40 -0
- package/types/src/comment/IComment.d.ts +319 -48
- package/types/src/comment/ICommentCollection.d.ts +90 -0
- package/types/src/comment/_CommentUtils.d.ts +28 -0
- package/types/src/comment/index.d.ts +1 -0
- package/types/src/condition/AnchoredConditional.d.ts +76 -17
- package/types/src/condition/BuiltInOperators/AbstractOperator.d.ts +8 -7
- package/types/src/condition/BuiltInOperators/EqualToOperator.d.ts +2 -1
- package/types/src/condition/BuiltInOperators/ExpressionOperator.d.ts +3 -6
- package/types/src/condition/BuiltInOperators/InSetOperator.d.ts +1 -1
- package/types/src/condition/BuiltinSelectors/BaseSelector.d.ts +7 -0
- package/types/src/condition/BuiltinSelectors/ListSelector.d.ts +9 -0
- package/types/src/condition/Condition.d.ts +16 -0
- package/types/src/condition/ICondition.d.ts +86 -33
- package/types/src/condition/_ConditionFormula.d.ts +152 -0
- package/types/src/condition/_ConditionUtils.d.ts +73 -10
- package/types/src/conditionalFormat/ConditionalFormat.d.ts +21 -10
- package/types/src/conditionalFormat/ConditionalFormatCollection.d.ts +19 -8
- package/types/src/conditionalFormat/IConditionalFormat.d.ts +5 -3
- package/types/src/conditionalFormat/IConditionalFormatCollection.d.ts +2 -0
- package/types/src/dataValidation/DataValidation.d.ts +50 -3
- package/types/src/dataValidation/DataValidationCollection.d.ts +20 -9
- package/types/src/dataValidation/IDataValidation.d.ts +119 -30
- package/types/src/dataValidation/IDataValidationCollection.d.ts +10 -2
- package/types/src/date/DateUtils.d.ts +20 -0
- package/types/src/date/_DateUtils.d.ts +91 -7
- package/types/src/externalBook/ExternalBookCollection.d.ts +145 -12
- package/types/src/externalBook/ExternalBookName.d.ts +96 -0
- package/types/src/externalBook/IExternalBook.d.ts +170 -18
- package/types/src/externalBook/IExternalBookCollection.d.ts +79 -7
- package/types/src/externalBook/index.d.ts +1 -0
- package/types/src/fill/IStroke.d.ts +1 -1
- package/types/src/filter/IFilter.d.ts +29 -4
- package/types/src/font/IFont.d.ts +17 -0
- package/types/src/history/IHistory.d.ts +3 -2
- package/types/src/i18n/LanguagePack.d.ts +12 -4
- package/types/src/index.d.ts +3 -0
- package/types/src/io/AbstractBackingStore.d.ts +24 -1
- package/types/src/io/ArrayBackingStore.d.ts +1 -1
- package/types/src/io/EmbeddedPart.d.ts +20 -0
- package/types/src/io/IEmbeddedPart.d.ts +63 -0
- package/types/src/io/IWorkbookIO.d.ts +185 -18
- package/types/src/io/WorkbookIO.d.ts +9 -0
- package/types/src/io/WorkbookOrigin.d.ts +20 -11
- package/types/src/io/WorkbookOriginProvider.d.ts +46 -0
- package/types/src/io/_XmlFragment.d.ts +49 -0
- package/types/src/io/index.d.ts +1 -0
- package/types/src/lib/file/file.browser.d.ts +19 -5
- package/types/src/lib/file/file.node.d.ts +5 -0
- package/types/src/lib/utils/_Utils.d.ts +11 -0
- package/types/src/lib/utils/utils.browser.d.ts +9 -3
- package/types/src/license/license-key.d.ts +27 -0
- package/types/src/listener/IListener.d.ts +12 -7
- package/types/src/listener/ListenerEmitter.d.ts +46 -5
- package/types/src/model/AbstractModel.d.ts +14 -5
- package/types/src/movable/Control.d.ts +57 -0
- package/types/src/movable/IControl.d.ts +84 -0
- package/types/src/movable/IMovable.d.ts +23 -1
- package/types/src/movable/IMovableCollection.d.ts +2 -0
- package/types/src/movable/Movable.d.ts +4 -6
- package/types/src/movable/MovableCollection.d.ts +7 -7
- package/types/src/movable/index.d.ts +4 -0
- package/types/src/named/AbstractNamed.d.ts +1 -1
- package/types/src/named/INamed.d.ts +4 -1
- package/types/src/named/INamedCollection.d.ts +26 -0
- package/types/src/named/NamedCollection.d.ts +16 -15
- package/types/src/numFmt/BuiltInFormats.d.ts +15 -7
- package/types/src/numFmt/IFormatEngine.d.ts +2 -0
- package/types/src/numFmt/NumfmtFormatEngine.d.ts +2 -0
- package/types/src/person/IPerson.d.ts +99 -0
- package/types/src/person/IPersonCollection.d.ts +51 -0
- package/types/src/person/Person.d.ts +32 -0
- package/types/src/person/PersonCollection.d.ts +49 -0
- package/types/src/person/index.d.ts +3 -0
- package/types/src/picture/IPicture.d.ts +2 -0
- package/types/src/picture/Picture.d.ts +2 -0
- package/types/src/pivot/IPivotTable.d.ts +107 -0
- package/types/src/pivot/IPivotTableCollection.d.ts +25 -0
- package/types/src/pivot/PivotTable.d.ts +57 -0
- package/types/src/pivot/PivotTableCollection.d.ts +25 -0
- package/types/src/pivot/index.d.ts +6 -0
- package/types/src/primitives/CompositeRangeStats.d.ts +2 -0
- package/types/src/primitives/Criteria.d.ts +1 -1
- package/types/src/primitives/LambdaBrand.d.ts +21 -0
- package/types/src/primitives/PrimitiveUtils.d.ts +56 -19
- package/types/src/primitives/Range.d.ts +102 -24
- package/types/src/primitives/RangeStats.d.ts +24 -1
- package/types/src/primitives/ReferenceRange.d.ts +42 -0
- package/types/src/primitives/Runtime.d.ts +15 -2
- package/types/src/primitives/stats/FrequencyStats.d.ts +9 -0
- package/types/src/primitives/stats/LookupIndex.d.ts +46 -0
- package/types/src/primitives/stats/SortedNumbers.d.ts +2 -0
- package/types/src/primitives/stats/index.d.ts +1 -0
- package/types/src/print/IPrint.d.ts +0 -22
- package/types/src/protectedRange/IProtectedRange.d.ts +4 -0
- package/types/src/protectedRange/IProtectedRangeCollection.d.ts +2 -0
- package/types/src/protectedRange/ProtectedRange.d.ts +1 -4
- package/types/src/protectedRange/ProtectedRangeCollection.d.ts +19 -8
- package/types/src/protection/DefaultProtection.d.ts +12 -1
- package/types/src/protection/IProtection.d.ts +36 -2
- package/types/src/reference/ReferenceUtils.d.ts +80 -0
- package/types/src/reference/index.d.ts +2 -0
- package/types/src/resource/IResource.d.ts +21 -1
- package/types/src/resource/IResourceCollection.d.ts +9 -1
- package/types/src/resource/ResourceCollection.d.ts +6 -6
- package/types/src/scripting/FunctionCollection.d.ts +41 -11
- package/types/src/scripting/IFunctionCollection.d.ts +41 -0
- package/types/src/scripting/IModule.d.ts +25 -0
- package/types/src/scripting/IModuleCollection.d.ts +17 -0
- package/types/src/scripting/IScript.d.ts +18 -0
- package/types/src/scripting/Module.d.ts +34 -6
- package/types/src/scripting/ModuleCollection.d.ts +17 -12
- package/types/src/scripting/Runtime.d.ts +15 -0
- package/types/src/scripting/Scripts.d.ts +2 -0
- package/types/src/scripting/TypedFunction.d.ts +151 -18
- package/types/src/scripting/_FunctionIndex.d.ts +5 -0
- package/types/src/scripting/_ModuleUtils.d.ts +11 -1
- package/types/src/scripting/_ScriptUtils.d.ts +3 -0
- package/types/src/scripting/declarations.browser.d.ts +10 -0
- package/types/src/scripting/declarations.d.ts +49 -0
- package/types/src/scripting/declarations.node.d.ts +9 -0
- package/types/src/scripting/index.d.ts +3 -0
- package/types/src/selection/IRangeSelection.d.ts +9 -4
- package/types/src/selection/RangeSelection.d.ts +2 -0
- package/types/src/shape/IShape.d.ts +41 -3
- package/types/src/shape/Shape.d.ts +10 -0
- package/types/src/shape/_ShapeXml.d.ts +28 -0
- package/types/src/sheet/CellRegion.d.ts +6 -0
- package/types/src/sheet/ICellContainerOptions.d.ts +50 -0
- package/types/src/sheet/ISheet.d.ts +224 -41
- package/types/src/sheet/ISheetCollection.d.ts +2 -5
- package/types/src/sheet/NamedCellRange.d.ts +16 -7
- package/types/src/sheet/Sheet.d.ts +749 -114
- package/types/src/sheet/SheetCell.d.ts +81 -21
- package/types/src/sheet/SheetCollection.d.ts +19 -8
- package/types/src/sheet/SheetRange.d.ts +62 -14
- package/types/src/sheet/SheetRanges.d.ts +4 -6
- package/types/src/sheet/_CellBuffer.d.ts +214 -0
- package/types/src/sheet/_InvalidSheetRange.d.ts +5 -5
- package/types/src/sheet/_ListenerAnchor.d.ts +104 -0
- package/types/src/sheet/_RangeStateSweep.d.ts +16 -0
- package/types/src/sheet/_ScalarListFactory.d.ts +61 -0
- package/types/src/sheet/_SheetAutoFillUtils.d.ts +74 -0
- package/types/src/sheet/_SheetAutoFitUtils.d.ts +2 -2
- package/types/src/sheet/_SheetEvents.d.ts +43 -0
- package/types/src/sheet/_SheetFilterUtils.d.ts +32 -1
- package/types/src/sheet/_SheetIntents.d.ts +250 -0
- package/types/src/sheet/_SheetMutations.d.ts +179 -59
- package/types/src/sheet/_SheetStateReader.d.ts +16 -10
- package/types/src/sheet/_SheetStateTypes.d.ts +57 -73
- package/types/src/sheet/_SheetUtils.d.ts +2 -18
- package/types/src/sheet/_WatchAnchor.d.ts +93 -0
- package/types/src/sheet/spatial/HeldFormulaEntry.d.ts +36 -0
- package/types/src/sheet/spatial/index.d.ts +1 -0
- package/types/src/sheet/style/SheetCellStyle.d.ts +91 -64
- package/types/src/sheet/style/SheetDirectStyle.d.ts +16 -5
- package/types/src/sheet/style/_Resolvers.d.ts +5 -3
- package/types/src/sheet/style/_StyleUtils.d.ts +37 -7
- package/types/src/sheetHeader/ISheetHeader.d.ts +2 -0
- package/types/src/sheetHeader/SheetHeader.d.ts +14 -0
- package/types/src/sheetProtection/ISheetProtection.d.ts +41 -7
- package/types/src/sheetProtection/SheetProtection.d.ts +12 -0
- package/types/src/sheetView/ISheetView.d.ts +45 -1
- package/types/src/sheetView/SheetView.d.ts +11 -0
- package/types/src/slicer/ISlicer.d.ts +2 -0
- package/types/src/slicer/Slicer.d.ts +2 -0
- package/types/src/sort/ISort.d.ts +2 -0
- package/types/src/string/IStringCollection.d.ts +5 -0
- package/types/src/string/StringCollection.d.ts +6 -6
- package/types/src/style/INamedStyleCollection.d.ts +72 -0
- package/types/src/style/IStyle.d.ts +30 -10
- package/types/src/style/IStyleCollection.d.ts +63 -42
- package/types/src/style/ITableStyleCollection.d.ts +89 -0
- package/types/src/style/NamedStyleCollection.d.ts +39 -0
- package/types/src/style/StyleCollection.d.ts +41 -5
- package/types/src/style/TableStyleCollection.d.ts +49 -0
- package/types/src/style/_BuiltInStyleDefs.d.ts +3 -3
- package/types/src/style/index.d.ts +4 -0
- package/types/src/table/AnchoredTable.d.ts +644 -68
- package/types/src/table/AutoTable.d.ts +5 -5
- package/types/src/table/ITable.d.ts +228 -30
- package/types/src/table/ITableCollection.d.ts +2 -0
- package/types/src/table/TableCollection.d.ts +19 -8
- package/types/src/table/_FilterField.d.ts +7 -5
- package/types/src/table/_NamedTable.d.ts +17 -1
- package/types/src/table/_NamedTableSource.d.ts +1 -0
- package/types/src/table/_SortField.d.ts +2 -0
- package/types/src/table/_TableColumn.d.ts +13 -2
- package/types/src/table/_TableMessages.d.ts +1 -0
- package/types/src/table/_TableUtils.d.ts +40 -0
- package/types/src/text/Bullet.d.ts +4 -0
- package/types/src/text/ITextFrame.d.ts +25 -1
- package/types/src/text/TextBoxAlignment.d.ts +15 -6
- package/types/src/text/TextFrame.d.ts +4 -0
- package/types/src/text/TextLine.d.ts +4 -0
- package/types/src/text/TextParagraph.d.ts +4 -0
- package/types/src/text/TextRun.d.ts +9 -0
- package/types/src/text/TextStacked.d.ts +83 -0
- package/types/src/text/index.d.ts +1 -0
- package/types/src/theme/ITheme.d.ts +2 -0
- package/types/src/theme/IThemeCollection.d.ts +2 -0
- package/types/src/theme/ThemeCollection.d.ts +8 -7
- package/types/src/transaction/ITransaction.d.ts +238 -36
- package/types/src/transaction/Transaction.d.ts +99 -11
- package/types/src/type/AbstractCollection.d.ts +101 -0
- package/types/src/type/ICollection.d.ts +117 -0
- package/types/src/type/ITypes.d.ts +9 -7
- package/types/src/type/index.d.ts +1 -0
- package/types/src/utils/_CSSUtils.d.ts +3 -3
- package/types/src/workbook/IWorkbook.d.ts +171 -40
- package/types/src/workbook/Workbook.d.ts +103 -7
- package/types/src/workbook/_WorkbookIntents.d.ts +36 -0
- package/types/src/workbookProtection/IWorkbookProtection.d.ts +7 -0
- package/types/src/workbookProtection/WorkbookProtection.d.ts +3 -0
- package/types/src/workbookView/IWorkbookView.d.ts +12 -0
- package/types/src/workbookView/WorkbookView.d.ts +5 -0
- package/browser/cjs/BatsV2UUraVDCRXm.cjs +0 -57
- package/browser/cjs/CUz53T65cRGQRgvv.cjs +0 -33
- package/browser/cjs/DU0kYUtdFa3jK-im.cjs +0 -1
- package/browser/cjs/Dv4yIPLV98M5zLHa.cjs +0 -1
- package/browser/esm/6JKSOvc5czaQB2Bj.mjs +0 -109
- package/browser/esm/BtuJ9AGzeURtAsGo.mjs +0 -51241
- package/browser/esm/DGU6sM25u0EWCKl1.mjs +0 -824
- package/browser/esm/f2G3QRgEbvFJcoa2.mjs +0 -4436
- package/node/esm/-pxdn3M3tc6PLHs7.mjs +0 -114
- package/node/esm/0n5bslM9jhO1JnI2.mjs +0 -843
- package/types/src/cellRange/_GraphNode.d.ts +0 -38
- package/types/src/dataValidation/_Utils.d.ts +0 -10
- package/types/src/sheet/listener/RangesListener.d.ts +0 -32
- package/types/src/sheet/listener/RangesListenerEntry.d.ts +0 -19
- package/types/src/sheet/listener/index.d.ts +0 -3
|
@@ -1,18 +1,16 @@
|
|
|
1
|
+
import { AbstractCollection } from '../type';
|
|
1
2
|
import { ITransaction } from '../transaction';
|
|
2
3
|
import { IListener } from '../listener';
|
|
3
4
|
import { ICellRanges } from '../cellRange';
|
|
4
5
|
import { INamed, INamedCollection } from '../named';
|
|
5
|
-
import { ListenerEmitter } from '../listener/ListenerEmitter';
|
|
6
6
|
export declare const REGEX_INVALID_NAME_FIRST_CHARS: RegExp;
|
|
7
7
|
export declare const REGEX_INVALID_NAME_TRAILING_CHARS: RegExp;
|
|
8
8
|
/**
|
|
9
9
|
* Implementation for `INamedCollection`.
|
|
10
10
|
*/
|
|
11
|
-
export declare class NamedCollection implements INamedCollection {
|
|
12
|
-
protected _emitter: ListenerEmitter<this, INamedCollection.IListeners>;
|
|
11
|
+
export declare class NamedCollection extends AbstractCollection<INamed, INamedCollection.GetItemsOptions> implements INamedCollection {
|
|
13
12
|
private _options;
|
|
14
|
-
|
|
15
|
-
private _closed;
|
|
13
|
+
protected _transactions: ITransaction.IStore;
|
|
16
14
|
private _lastLookup;
|
|
17
15
|
private _lastLookupAddress;
|
|
18
16
|
private _lastLookupType;
|
|
@@ -51,10 +49,8 @@ export declare class NamedCollection implements INamedCollection {
|
|
|
51
49
|
* the name.
|
|
52
50
|
*/
|
|
53
51
|
private _getOwningSource;
|
|
54
|
-
/** {@inheritDoc
|
|
55
|
-
|
|
56
|
-
/** {@inheritDoc INamedCollection.getItems} */
|
|
57
|
-
getItems(options?: INamedCollection.GetItemsOptions): INamed[];
|
|
52
|
+
/** {@inheritDoc AbstractCollection._getItems} */
|
|
53
|
+
protected _getItems(options?: INamedCollection.GetItemsOptions): INamed[];
|
|
58
54
|
/** {@inheritDoc INamedCollection.getByRanges} */
|
|
59
55
|
getByRanges(ranges: ICellRanges.Address, options?: INamedCollection.GetByRangesOptions): string[];
|
|
60
56
|
/** {@link getByRanges}, against an explicit anchor — see {@link _scopedTo}. */
|
|
@@ -131,8 +127,6 @@ export declare class NamedCollection implements INamedCollection {
|
|
|
131
127
|
* distinct names, so a scoped query must not report the global one as a hit.
|
|
132
128
|
*/
|
|
133
129
|
private _findInSourcesByKey;
|
|
134
|
-
/** {@inheritDoc ICollection.getCount} */
|
|
135
|
-
getCount(): number;
|
|
136
130
|
/** {@inheritDoc INamedCollection.findValidName} */
|
|
137
131
|
findValidName(template: string, scope?: string | null, ignoreExisting?: boolean): string;
|
|
138
132
|
/** {@inheritDoc INamedCollection.validateName} */
|
|
@@ -163,7 +157,7 @@ export declare class NamedCollection implements INamedCollection {
|
|
|
163
157
|
private _invalidateLookup;
|
|
164
158
|
/** {@inheritDoc IListener.ISource.addListeners} */
|
|
165
159
|
addListeners(listeners: INamedCollection.IListeners, options?: IListener.Options): IListener.Remove;
|
|
166
|
-
|
|
160
|
+
/** {@inheritDoc INamedCollection.close} */
|
|
167
161
|
close(): void;
|
|
168
162
|
/**
|
|
169
163
|
* {@inheritDoc INamedCollection.isINamedCollection}
|
|
@@ -217,14 +211,21 @@ export declare namespace NamedCollection {
|
|
|
217
211
|
*/
|
|
218
212
|
getItems(): readonly INamed[];
|
|
219
213
|
/**
|
|
220
|
-
* Notified when items are added, removed, renamed or re-scoped
|
|
214
|
+
* Notified when items are added, removed, renamed or re-scoped (`onCollectionChange`), and when
|
|
215
|
+
* an undo or a redo has moved them (`onInvalidated`).
|
|
221
216
|
*
|
|
222
217
|
* @remarks
|
|
223
|
-
* The aggregator re-emits
|
|
224
|
-
*
|
|
218
|
+
* The aggregator re-emits each as its own event of the same name, and either drops its lookup
|
|
219
|
+
* memo — a source changing behind a cached result is otherwise invisible.
|
|
220
|
+
*
|
|
221
|
+
* A source that has no restore of its own to report may implement only the first; one whose
|
|
222
|
+
* items are DERIVED (tables) has to report both, because an undo of a rename moves nothing this
|
|
223
|
+
* collection holds. The two stay separate all the way through: consumers of a restore and
|
|
224
|
+
* consumers of a write are not the same set.
|
|
225
225
|
*/
|
|
226
226
|
addListeners(listeners: {
|
|
227
227
|
onCollectionChange?: (...args: any[]) => void;
|
|
228
|
+
onInvalidated?: (...args: any[]) => void;
|
|
228
229
|
}, options?: IListener.Options): IListener.Remove;
|
|
229
230
|
/**
|
|
230
231
|
* Creates a name owned by this source, if it can own one.
|
|
@@ -20,14 +20,22 @@ export declare const FIRST_CUSTOM_FORMAT_ID = 164;
|
|
|
20
20
|
export declare const BUILT_IN_FORMAT_CODES: Readonly<Record<number, string>>;
|
|
21
21
|
/**
|
|
22
22
|
* Ids whose rendering adapts to the viewer's regional settings in Excel (the
|
|
23
|
-
* `*`-prefixed formats in the Format Cells dialog, currency symbol ids,
|
|
24
|
-
*
|
|
23
|
+
* `*`-prefixed formats in the Format Cells dialog, currency symbol ids, the
|
|
24
|
+
* date/time ids Excel renders with a per-locale pattern, and the regional/CJK
|
|
25
|
+
* 27-36 & 50-58 ranges).
|
|
25
26
|
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* The date/time ids render through {@link getLocaleBuiltInFormatCode} where a
|
|
28
|
+
* locale's pattern is known, and 14/22 fall back to `Intl` otherwise
|
|
29
|
+
* (`toLocaleDateCore`). The rest resolve to their canonical en-US codes.
|
|
29
30
|
*/
|
|
30
31
|
export declare const LOCALE_ADAPTIVE_IDS: ReadonlySet<number>;
|
|
32
|
+
/**
|
|
33
|
+
* The code a built-in id renders with in `locale`, or `undefined` when the
|
|
34
|
+
* locale is not measured or renders the canonical code.
|
|
35
|
+
*
|
|
36
|
+
* @param locale BCP-47 tag. @defaultValue 'en-US'
|
|
37
|
+
*/
|
|
38
|
+
export declare function getLocaleBuiltInFormatCode(id: number, locale?: string): string | undefined;
|
|
31
39
|
/** The raw ECMA table lookup, or `undefined` for unknown ids. */
|
|
32
40
|
export declare function getBuiltInFormatCode(id: number): string | undefined;
|
|
33
41
|
/**
|
|
@@ -42,8 +50,8 @@ export declare function getBuiltInFormatCode(id: number): string | undefined;
|
|
|
42
50
|
*/
|
|
43
51
|
export declare function resolveNumberFormat(ref: NumberFormatRef): string;
|
|
44
52
|
/**
|
|
45
|
-
* Find the built-in id
|
|
46
|
-
*
|
|
53
|
+
* Find the built-in id Excel saves a format code as, or `undefined` if Excel
|
|
54
|
+
* saves it as a custom format.
|
|
47
55
|
*/
|
|
48
56
|
export declare function findBuiltInFormatId(code: string): number | undefined;
|
|
49
57
|
//# sourceMappingURL=BuiltInFormats.d.ts.map
|
|
@@ -138,6 +138,8 @@ export interface IFormatEngine {
|
|
|
138
138
|
getFormatDateInfo(format: NumberFormatRef): FormatDateInfo | null;
|
|
139
139
|
/** True if the format code parses (usable for live custom-code validation). */
|
|
140
140
|
isValidFormat(format: NumberFormatRef): boolean;
|
|
141
|
+
/** For runtime type checking. */
|
|
142
|
+
readonly isIFormatEngine: true;
|
|
141
143
|
}
|
|
142
144
|
/**
|
|
143
145
|
* The number-format engine.
|
|
@@ -29,5 +29,7 @@ export declare class NumfmtFormatEngine implements IFormatEngine {
|
|
|
29
29
|
getFormatDateInfo(format: NumberFormatRef): FormatDateInfo | null;
|
|
30
30
|
/** @inheritdoc IFormatEngine.isValidFormat */
|
|
31
31
|
isValidFormat(format: NumberFormatRef): boolean;
|
|
32
|
+
/** {@inheritDoc IFormatEngine.isIFormatEngine} */
|
|
33
|
+
get isIFormatEngine(): true;
|
|
32
34
|
}
|
|
33
35
|
//# sourceMappingURL=NumfmtFormatEngine.d.ts.map
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A person known to the workbook: the author of a comment, or someone mentioned in one.
|
|
3
|
+
*
|
|
4
|
+
* @remarks
|
|
5
|
+
* Excel keeps these in a workbook-wide list (`xl/persons/person.xml`) and refers to each by id
|
|
6
|
+
* from every threaded comment. A legacy note names its author by display name alone; the reader
|
|
7
|
+
* mints a person for it so both kinds answer {@link IComment.getAuthor} the same way.
|
|
8
|
+
*
|
|
9
|
+
* A person is added when a comment names an author the workbook has not seen, and removed with
|
|
10
|
+
* {@link delete}; a comment whose author was removed answers `null` for them.
|
|
11
|
+
*/
|
|
12
|
+
export interface IPerson {
|
|
13
|
+
/**
|
|
14
|
+
* The unique identifier.
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* A GUID in files Excel wrote; anything unique within the workbook otherwise.
|
|
18
|
+
*/
|
|
19
|
+
getId(): string;
|
|
20
|
+
/**
|
|
21
|
+
* The name shown beside the person's comments.
|
|
22
|
+
*/
|
|
23
|
+
getDisplayName(): string;
|
|
24
|
+
/**
|
|
25
|
+
* The id the person is known by to their identity provider, or `null` if there is none.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* Excel keeps an email address here for a person signed in to an organization. Nothing in
|
|
29
|
+
* SheetXL resolves it.
|
|
30
|
+
*/
|
|
31
|
+
getUserId(): string | null;
|
|
32
|
+
/**
|
|
33
|
+
* The identity provider that vouches for the {@link getUserId | user id}, or `null` if there is
|
|
34
|
+
* none.
|
|
35
|
+
*
|
|
36
|
+
* @remarks
|
|
37
|
+
* Excel writes `AD` for a directory account, `Windows Live` for a personal one, and `None` for
|
|
38
|
+
* a name typed with no account behind it.
|
|
39
|
+
*/
|
|
40
|
+
getProviderId(): string | null;
|
|
41
|
+
/**
|
|
42
|
+
* Removes the person from the workbook.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* Comments they wrote keep their text and lose their author.
|
|
46
|
+
*/
|
|
47
|
+
delete(): void;
|
|
48
|
+
/**
|
|
49
|
+
* Returns `true` once the person has been removed.
|
|
50
|
+
*/
|
|
51
|
+
isDeleted(): boolean;
|
|
52
|
+
/**
|
|
53
|
+
* @returns The current state as a JSON object.
|
|
54
|
+
*/
|
|
55
|
+
toJSON(): IPerson.JSON;
|
|
56
|
+
/**
|
|
57
|
+
* For runtime type checking.
|
|
58
|
+
*/
|
|
59
|
+
readonly isIPerson: true;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* {@inheritDoc IPerson}
|
|
63
|
+
* @see
|
|
64
|
+
* ### **Interface**
|
|
65
|
+
*
|
|
66
|
+
* {@link IPerson}
|
|
67
|
+
*
|
|
68
|
+
* **Additional Interfaces**
|
|
69
|
+
* * {@link IPersonCollection}
|
|
70
|
+
*/
|
|
71
|
+
export declare namespace IPerson {
|
|
72
|
+
/**
|
|
73
|
+
* The values that describe a person.
|
|
74
|
+
*/
|
|
75
|
+
interface Properties {
|
|
76
|
+
/**
|
|
77
|
+
* {@inheritDoc IPerson.getDisplayName}
|
|
78
|
+
*/
|
|
79
|
+
displayName: string;
|
|
80
|
+
/**
|
|
81
|
+
* {@inheritDoc IPerson.getUserId}
|
|
82
|
+
*/
|
|
83
|
+
userId?: string;
|
|
84
|
+
/**
|
|
85
|
+
* {@inheritDoc IPerson.getProviderId}
|
|
86
|
+
*/
|
|
87
|
+
providerId?: string;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* A JSON representation useful for persistence.
|
|
91
|
+
*/
|
|
92
|
+
interface JSON extends Properties {
|
|
93
|
+
/**
|
|
94
|
+
* {@inheritDoc IPerson.getId}
|
|
95
|
+
*/
|
|
96
|
+
id: string;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=IPerson.d.ts.map
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { ICollection } from '../type';
|
|
2
|
+
import { IPerson } from './IPerson';
|
|
3
|
+
/**
|
|
4
|
+
* Holds the {@link IPerson | people} a workbook knows: everyone who authored or is mentioned in
|
|
5
|
+
* a comment.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Keyed by id. Adding a person whose id, or whose display name, is already here returns the
|
|
9
|
+
* existing one rather than a second copy, which is what lets a legacy note's author (a display
|
|
10
|
+
* name with no id) and a threaded comment's author (an id) land on one person.
|
|
11
|
+
*/
|
|
12
|
+
export interface IPersonCollection extends ICollection<IPerson> {
|
|
13
|
+
/**
|
|
14
|
+
* Adds a person, or returns the one already here with the same id or display name.
|
|
15
|
+
*
|
|
16
|
+
* @param person The person's properties, or a display name alone.
|
|
17
|
+
*/
|
|
18
|
+
add(person: IPerson.Properties | string): IPerson;
|
|
19
|
+
/**
|
|
20
|
+
* Returns the person with the given id, or `null` if there is none.
|
|
21
|
+
*/
|
|
22
|
+
getById(id: string): IPerson | null;
|
|
23
|
+
/**
|
|
24
|
+
* Returns the person with the given display name, or `null` if there is none.
|
|
25
|
+
*
|
|
26
|
+
* @param displayName The display name. Case sensitive, as Excel keeps it.
|
|
27
|
+
*/
|
|
28
|
+
getByDisplayName(displayName: string): IPerson | null;
|
|
29
|
+
/**
|
|
30
|
+
* The person a new comment is authored by when none is named.
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* Excel uses the signed-in user; SheetXL has no user, so this is whoever {@link setCurrent}
|
|
34
|
+
* named, and otherwise a person called `Author`, added on first use.
|
|
35
|
+
*/
|
|
36
|
+
getCurrent(): IPerson;
|
|
37
|
+
/**
|
|
38
|
+
* Names the person new comments are authored by.
|
|
39
|
+
*
|
|
40
|
+
* @param person A person, a person's properties, a display name, or `null` to forget the
|
|
41
|
+
* choice. A person not yet in the collection is added.
|
|
42
|
+
*/
|
|
43
|
+
setCurrent(person: IPerson | IPerson.Properties | string | null): void;
|
|
44
|
+
/**
|
|
45
|
+
* Serializes to JSON, or `null` if there is no one to write.
|
|
46
|
+
*/
|
|
47
|
+
toJSON(): IPerson.JSON[] | null;
|
|
48
|
+
/** For runtime type checking. */
|
|
49
|
+
readonly isIPersonCollection: true;
|
|
50
|
+
}
|
|
51
|
+
//# sourceMappingURL=IPersonCollection.d.ts.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { IPerson } from './IPerson';
|
|
2
|
+
/**
|
|
3
|
+
* Implementation of {@link IPerson}.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* Immutable: a person is never edited, only added and removed.
|
|
7
|
+
*/
|
|
8
|
+
export declare class Person implements IPerson {
|
|
9
|
+
private readonly _json;
|
|
10
|
+
private readonly _deleteFromCollection;
|
|
11
|
+
private _deleted;
|
|
12
|
+
constructor(json: IPerson.JSON, deleteFromCollection?: (person: Person) => void);
|
|
13
|
+
/** {@inheritDoc IPerson.getId} */
|
|
14
|
+
getId(): string;
|
|
15
|
+
/** {@inheritDoc IPerson.getDisplayName} */
|
|
16
|
+
getDisplayName(): string;
|
|
17
|
+
/** {@inheritDoc IPerson.getUserId} */
|
|
18
|
+
getUserId(): string | null;
|
|
19
|
+
/** {@inheritDoc IPerson.getProviderId} */
|
|
20
|
+
getProviderId(): string | null;
|
|
21
|
+
/** {@inheritDoc IPerson.delete} */
|
|
22
|
+
delete(): void;
|
|
23
|
+
/** {@inheritDoc IPerson.isDeleted} */
|
|
24
|
+
isDeleted(): boolean;
|
|
25
|
+
/** {@inheritDoc IPerson.toJSON} */
|
|
26
|
+
toJSON(): IPerson.JSON;
|
|
27
|
+
get [Symbol.toStringTag](): string;
|
|
28
|
+
toString(): string;
|
|
29
|
+
/** {@inheritDoc IPerson.isIPerson} */
|
|
30
|
+
get isIPerson(): true;
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=Person.d.ts.map
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { AbstractCollection } from '../type';
|
|
2
|
+
import { IPerson } from './IPerson';
|
|
3
|
+
import { IPersonCollection } from './IPersonCollection';
|
|
4
|
+
/**
|
|
5
|
+
* The display name of the person minted when a comment is added and nobody was named.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Data, not UI text: it is written into the file as the author, so it is not localized.
|
|
9
|
+
*/
|
|
10
|
+
export declare const DEFAULT_AUTHOR_NAME = "Author";
|
|
11
|
+
/**
|
|
12
|
+
* Implementation for {@link IPersonCollection}.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Not transactional: a person is added as a side effect of authoring a comment, and a removal is
|
|
16
|
+
* not something Excel offers to undo either. Announces `onCollectionChange` on each change.
|
|
17
|
+
*/
|
|
18
|
+
export declare class PersonCollection extends AbstractCollection<IPerson> implements IPersonCollection {
|
|
19
|
+
private _byId;
|
|
20
|
+
private _byDisplayName;
|
|
21
|
+
private _items;
|
|
22
|
+
private _current;
|
|
23
|
+
constructor(json?: IPerson.JSON[] | null);
|
|
24
|
+
/** {@inheritDoc AbstractCollection._getItems} */
|
|
25
|
+
protected _getItems(): IPerson[];
|
|
26
|
+
/** {@inheritDoc ICollection.getCount} */
|
|
27
|
+
getCount(): number;
|
|
28
|
+
/** {@inheritDoc IPersonCollection.add} */
|
|
29
|
+
add(person: IPerson.Properties | string): IPerson;
|
|
30
|
+
/** {@inheritDoc IPersonCollection.getById} */
|
|
31
|
+
getById(id: string): IPerson | null;
|
|
32
|
+
/** {@inheritDoc IPersonCollection.getByDisplayName} */
|
|
33
|
+
getByDisplayName(displayName: string): IPerson | null;
|
|
34
|
+
/** {@inheritDoc IPersonCollection.getCurrent} */
|
|
35
|
+
getCurrent(): IPerson;
|
|
36
|
+
/** {@inheritDoc IPersonCollection.setCurrent} */
|
|
37
|
+
setCurrent(person: IPerson | IPerson.Properties | string | null): void;
|
|
38
|
+
/** @internal */
|
|
39
|
+
protected _remove(person: IPerson): void;
|
|
40
|
+
/** {@inheritDoc IPersonCollection.toJSON} */
|
|
41
|
+
toJSON(): IPerson.JSON[] | null;
|
|
42
|
+
/**
|
|
43
|
+
* Loads people from JSON, keeping any already here.
|
|
44
|
+
*/
|
|
45
|
+
fromJSON(json: IPerson.JSON[] | null | undefined): void;
|
|
46
|
+
/** {@inheritDoc IPersonCollection.isIPersonCollection} */
|
|
47
|
+
get isIPersonCollection(): true;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=PersonCollection.d.ts.map
|
|
@@ -23,6 +23,8 @@ export interface IPicture extends IModel {
|
|
|
23
23
|
* Returns a local object URL for placing in an image tag.
|
|
24
24
|
*/
|
|
25
25
|
getDetails(): Promise<IPicture.Details>;
|
|
26
|
+
/** For runtime type checking. */
|
|
27
|
+
readonly isIPicture: true;
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
28
30
|
* {@inheritDoc IPicture}
|
|
@@ -35,6 +35,8 @@ export declare class Picture extends AbstractModel<State, IPicture.JSON> impleme
|
|
|
35
35
|
protected _toDrawingJSON(toResourceId?: (resource: IResource) => number | null): IPicture.JSON;
|
|
36
36
|
/** @internal */
|
|
37
37
|
protected _processDelete(): void;
|
|
38
|
+
/** {@inheritDoc IPicture.isIPicture} */
|
|
39
|
+
get isIPicture(): true;
|
|
38
40
|
}
|
|
39
41
|
/**
|
|
40
42
|
* Interfaces for creating `Picture` items.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { IResource } from '../resource';
|
|
2
|
+
import { ISheet } from '../sheet';
|
|
3
|
+
import { IEmbeddedPart } from '../io';
|
|
4
|
+
/**
|
|
5
|
+
* Interface for working with a pivot table — a summary of source data laid out on a sheet.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* Read-only for now: the table is carried as it was read and written back unchanged, which also
|
|
9
|
+
* means its location does not follow rows and columns that are inserted or deleted.
|
|
10
|
+
* {@link IPivotTable.getXML} is the read-only view of that markup.
|
|
11
|
+
*/
|
|
12
|
+
export interface IPivotTable {
|
|
13
|
+
/** @internal */
|
|
14
|
+
toJSON(toResourceId?: (resource: IResource) => number | null): IPivotTable.JSON | null;
|
|
15
|
+
/**
|
|
16
|
+
* Returns the name of the pivot table.
|
|
17
|
+
*
|
|
18
|
+
* @remarks
|
|
19
|
+
* Unique within the workbook, as Excel keeps it.
|
|
20
|
+
*/
|
|
21
|
+
getName(): string;
|
|
22
|
+
/**
|
|
23
|
+
* Returns the sheet the pivot table is laid out on.
|
|
24
|
+
*/
|
|
25
|
+
getSheet(): ISheet;
|
|
26
|
+
/**
|
|
27
|
+
* Returns the pivot table's own markup, or `null` if none was captured.
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Read-only, and the one escape hatch for what the table does not model yet: it is the
|
|
31
|
+
* `<pivotTableDefinition>` the table was read from, not its cache. It will be removed when the
|
|
32
|
+
* table is modeled.
|
|
33
|
+
*/
|
|
34
|
+
getXML(): string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Returns the id of the cache this table summarizes.
|
|
37
|
+
*
|
|
38
|
+
* @see {@link IPivotTable.getCache}
|
|
39
|
+
*
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
getCacheId(): number;
|
|
43
|
+
/** For runtime type checking. */
|
|
44
|
+
readonly isIPivotTable: true;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* {@inheritDoc IPivotTable}
|
|
48
|
+
* @see
|
|
49
|
+
* ### **Interface**
|
|
50
|
+
*
|
|
51
|
+
* {@link IPivotTable}
|
|
52
|
+
*/
|
|
53
|
+
export declare namespace IPivotTable {
|
|
54
|
+
/**
|
|
55
|
+
* One pivot cache — the snapshot of source data a pivot table summarizes.
|
|
56
|
+
*
|
|
57
|
+
* @remarks
|
|
58
|
+
* A cache belongs to the workbook rather than to any one sheet because it is shared: several
|
|
59
|
+
* tables can summarize the same source, and the snapshot is the expensive part, so it is held
|
|
60
|
+
* once and referenced from each table by id ({@link IPivotTable.getCacheId}).
|
|
61
|
+
*
|
|
62
|
+
* JSON only: a cache has no model and nothing public returns one — the table is the modeled side.
|
|
63
|
+
* It is carried so a workbook read with pivot tables can be written back with them; a table whose
|
|
64
|
+
* cache is missing is a file Excel refuses.
|
|
65
|
+
*
|
|
66
|
+
* @see {@link IWorkbook.JSON.pivotCaches}, which holds them.
|
|
67
|
+
*/
|
|
68
|
+
interface CacheJSON {
|
|
69
|
+
/** The id the workbook's pivot tables reference this cache by. */
|
|
70
|
+
cacheId: number;
|
|
71
|
+
/**
|
|
72
|
+
* The part describing the cache: what its source is, its fields, and the records it holds.
|
|
73
|
+
*
|
|
74
|
+
* @remarks
|
|
75
|
+
* Opaque: held as it was read and written back unchanged, since the cache has no model yet.
|
|
76
|
+
*/
|
|
77
|
+
part?: IEmbeddedPart.JSON;
|
|
78
|
+
}
|
|
79
|
+
interface JSON {
|
|
80
|
+
/**
|
|
81
|
+
* The name of the table.
|
|
82
|
+
*
|
|
83
|
+
* @remarks
|
|
84
|
+
* A mirror of the `name` attribute in {@link JSON.part}'s markup, which is authoritative;
|
|
85
|
+
* carried so the name is answered without reading the markup. Read from the markup once when
|
|
86
|
+
* absent.
|
|
87
|
+
*
|
|
88
|
+
* @see {@link IPivotTable.getName}
|
|
89
|
+
*/
|
|
90
|
+
name?: string;
|
|
91
|
+
/**
|
|
92
|
+
* The id of the cache the table summarizes.
|
|
93
|
+
*
|
|
94
|
+
* @see {@link IPivotTable.getCacheId}
|
|
95
|
+
*/
|
|
96
|
+
cacheId: number;
|
|
97
|
+
/**
|
|
98
|
+
* The part describing the table: its layout, its fields, and where it sits on the sheet.
|
|
99
|
+
*
|
|
100
|
+
* @remarks
|
|
101
|
+
* Opaque: held as it was read and written back unchanged, since the table has no model yet.
|
|
102
|
+
* {@link IPivotTable.getXML} is the readable view of it.
|
|
103
|
+
*/
|
|
104
|
+
part?: IEmbeddedPart.JSON;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=IPivotTable.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { ICollection } from '../type';
|
|
2
|
+
import { IPivotTable } from './IPivotTable';
|
|
3
|
+
/**
|
|
4
|
+
* Holds {@link IPivotTable | pivot tables} — a sheet's, or every sheet's in the workbook.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* Read-only for now: a table is carried as it was read and written back unchanged. Adding,
|
|
8
|
+
* deleting and refreshing wait on the table having a model of its own.
|
|
9
|
+
*/
|
|
10
|
+
export interface IPivotTableCollection extends ICollection<IPivotTable> {
|
|
11
|
+
/**
|
|
12
|
+
* Returns the pivot tables, in the order they were read; the workbook's walks its sheets in
|
|
13
|
+
* sheet order.
|
|
14
|
+
*/
|
|
15
|
+
getItems(options?: ICollection.GetItemsOptions): IPivotTable[];
|
|
16
|
+
/**
|
|
17
|
+
* Returns the pivot table with the given name, or `null` if there is none.
|
|
18
|
+
*
|
|
19
|
+
* @param name The name of the pivot table. This is case insensitive.
|
|
20
|
+
*/
|
|
21
|
+
getByName(name: string): IPivotTable | null;
|
|
22
|
+
/** For runtime type checking. */
|
|
23
|
+
readonly isIPivotTableCollection: true;
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=IPivotTableCollection.d.ts.map
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { IResource } from '../resource';
|
|
2
|
+
import { ISheet } from '../sheet';
|
|
3
|
+
import { IEmbeddedPart } from '../io';
|
|
4
|
+
import { IPivotTable } from './IPivotTable';
|
|
5
|
+
/**
|
|
6
|
+
* Implementation for {@link IPivotTable}.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Held as read until the table has a model of its own. Not sheet state: nothing edits it, so it
|
|
10
|
+
* neither transacts nor notifies.
|
|
11
|
+
*
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
export declare class PivotTable implements IPivotTable {
|
|
15
|
+
protected _name: string | null;
|
|
16
|
+
protected _sheet: ISheet;
|
|
17
|
+
protected _cacheId: number;
|
|
18
|
+
protected _part: IEmbeddedPart | null;
|
|
19
|
+
constructor(options: PivotTable.ConstructorOptions);
|
|
20
|
+
/** {@inheritDoc IPivotTable.getName} */
|
|
21
|
+
getName(): string;
|
|
22
|
+
/** {@inheritDoc IPivotTable.getSheet} */
|
|
23
|
+
getSheet(): ISheet;
|
|
24
|
+
/** {@inheritDoc IPivotTable.getXML} */
|
|
25
|
+
getXML(): string | null;
|
|
26
|
+
/** {@inheritDoc IPivotTable.getCacheId} */
|
|
27
|
+
getCacheId(): number;
|
|
28
|
+
/** {@inheritDoc IPivotTable.toJSON} */
|
|
29
|
+
toJSON(toResourceId?: (resource: IResource) => number | null): IPivotTable.JSON | null;
|
|
30
|
+
/** {@inheritDoc IPivotTable.isIPivotTable} */
|
|
31
|
+
get isIPivotTable(): true;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Interfaces for creating `PivotTable` items.
|
|
35
|
+
*
|
|
36
|
+
* @see
|
|
37
|
+
* ### **Interface**
|
|
38
|
+
*
|
|
39
|
+
* {@link PivotTable}
|
|
40
|
+
*/
|
|
41
|
+
export declare namespace PivotTable {
|
|
42
|
+
/**
|
|
43
|
+
* Options for creating a PivotTable.
|
|
44
|
+
*/
|
|
45
|
+
interface ConstructorOptions {
|
|
46
|
+
json: IPivotTable.JSON;
|
|
47
|
+
/**
|
|
48
|
+
* The sheet the table is laid out on.
|
|
49
|
+
*/
|
|
50
|
+
sheet: ISheet;
|
|
51
|
+
/**
|
|
52
|
+
* Returns an IResource from the resourceId or null if not found.
|
|
53
|
+
*/
|
|
54
|
+
fromResourceId?: (resourceId: number) => IResource;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=PivotTable.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { AbstractCollection } from '../type';
|
|
2
|
+
import { IPivotTable } from './IPivotTable';
|
|
3
|
+
import { IPivotTableCollection } from './IPivotTableCollection';
|
|
4
|
+
/**
|
|
5
|
+
* Implementation for {@link IPivotTableCollection}.
|
|
6
|
+
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* A front over storage held elsewhere — the sheet's own tables, or a walk over every sheet's for
|
|
9
|
+
* the workbook — so the same class serves both. Nothing edits a pivot table yet, so there is
|
|
10
|
+
* nothing to announce.
|
|
11
|
+
*/
|
|
12
|
+
export declare class PivotTableCollection extends AbstractCollection<IPivotTable> implements IPivotTableCollection {
|
|
13
|
+
private _getItemsDelegate;
|
|
14
|
+
/**
|
|
15
|
+
* @param getItems Returns the tables, as an array the caller may keep.
|
|
16
|
+
*/
|
|
17
|
+
constructor(getItems: () => IPivotTable[]);
|
|
18
|
+
/** {@inheritDoc AbstractCollection._getItems} */
|
|
19
|
+
protected _getItems(): IPivotTable[];
|
|
20
|
+
/** {@inheritDoc IPivotTableCollection.getByName} */
|
|
21
|
+
getByName(name: string): IPivotTable | null;
|
|
22
|
+
/** {@inheritDoc IPivotTableCollection.isIPivotTableCollection} */
|
|
23
|
+
get isIPivotTableCollection(): true;
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=PivotTableCollection.d.ts.map
|
|
@@ -24,6 +24,8 @@ export declare class CompositeRangeStats implements IRangeStats {
|
|
|
24
24
|
protected _typedCounts: Readonly<Record<ScalarType, number>> | undefined;
|
|
25
25
|
protected _frequencies: Readonly<IRangeStats.IFrequency> | undefined;
|
|
26
26
|
constructor(children: readonly IRangeStats[]);
|
|
27
|
+
/** @inheritdoc IRangeStats.getCoords */
|
|
28
|
+
getCoords(): IRange.Coords | null;
|
|
27
29
|
/** @inheritdoc IRangeStats.getSize */
|
|
28
30
|
getSize(): number;
|
|
29
31
|
/** @inheritdoc IRangeStats.getCount */
|
|
@@ -30,6 +30,6 @@ export declare const Criteria: {
|
|
|
30
30
|
* Parse criteria and return a predicate function for testing values against it.
|
|
31
31
|
* Each operator gets its own closure, avoiding repeated branching on every call.
|
|
32
32
|
*/
|
|
33
|
-
createEvaluator: (context: IFormulaContext, criteria: Scalar) => IFormulaContext.CriteriaEvaluator;
|
|
33
|
+
createEvaluator: (context: IFormulaContext, criteria: Scalar, options?: IFormulaContext.CriteriaOptions) => IFormulaContext.CriteriaEvaluator;
|
|
34
34
|
};
|
|
35
35
|
//# sourceMappingURL=Criteria.d.ts.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { LambdaCallable } from '../calculation/formula/LambdaValue';
|
|
2
|
+
/**
|
|
3
|
+
* The brand a function value carries — what `LAMBDA(…)` evaluates to (`LambdaValue`) and what a
|
|
4
|
+
* bare function name eta-reduces to (`FunctionValue`).
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* CALCULATION-PRIVATE, like the values it brands: no public API accepts or returns one, and a
|
|
8
|
+
* function author never sees one — a lambda-typed parameter is marshalled to a plain callable
|
|
9
|
+
* (`Lambda`) before the body runs. The brand exists so that the value-layer sites — coercion, the
|
|
10
|
+
* operators, a range's typed read — can RECOGNIZE a function value and refuse it without importing
|
|
11
|
+
* the calculation layer — the same structural pattern, and for the same reason, as `CalcSignal`.
|
|
12
|
+
*/
|
|
13
|
+
export interface ILambdaValue {
|
|
14
|
+
/** The brand itself — the property every recognizing site reads. */
|
|
15
|
+
readonly isLambda: true;
|
|
16
|
+
/** Marshals the value into the callable a lambda-typed parameter receives. */
|
|
17
|
+
makeCallable(): LambdaCallable;
|
|
18
|
+
}
|
|
19
|
+
/** `true` for a function value — see {@link ILambdaValue}. */
|
|
20
|
+
export declare const isLambdaValue: (value: unknown) => value is ILambdaValue;
|
|
21
|
+
//# sourceMappingURL=LambdaBrand.d.ts.map
|