@sheetxl/react 0.8.0-beta.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +8 -7
- package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
- package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
- package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
- package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
- package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
- package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
- package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
- package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
- package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
- package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
- package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
- package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
- package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
- package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
- package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
- package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
- package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
- package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
- package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
- package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
- package/browser/esm/SJAlYSFKC-5yNZ-C.mjs +2706 -0
- package/browser/esm/chart.mjs +41 -0
- package/browser/esm/control.mjs +217 -0
- package/browser/esm/group.mjs +123 -0
- package/browser/esm/index.mjs +22289 -13986
- package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
- package/browser/esm/note.mjs +112 -0
- package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
- package/browser/esm/picture.mjs +7 -0
- package/browser/esm/shape.mjs +7 -0
- package/browser/esm/slicer.mjs +282 -0
- package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
- package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
- package/licenses/dependencies.txt +284 -565
- package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
- package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
- package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
- package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
- package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
- package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
- package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
- package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
- package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
- package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
- package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
- package/node/esm/CeMKhq6cSxfWzN5H.mjs +2706 -0
- package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
- package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
- package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
- package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
- package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
- package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
- package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
- package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
- package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
- package/node/esm/chart.mjs +41 -0
- package/node/esm/control.mjs +217 -0
- package/node/esm/group.mjs +123 -0
- package/node/esm/index.mjs +18027 -9614
- package/node/esm/note.mjs +113 -0
- package/node/esm/picture.mjs +326 -0
- package/node/esm/shape.mjs +342 -0
- package/node/esm/slicer.mjs +284 -0
- package/package.json +56 -15
- package/resources/contents.json +36 -0
- package/resources/locales/contents.json +84 -0
- package/resources/locales/de/chart.cmd.json +82 -0
- package/resources/locales/de/movable.cmd.json +68 -0
- package/resources/locales/de/picture.cmd.json +188 -0
- package/resources/locales/de/pivot.cmd.json +79 -0
- package/resources/locales/de/shape.cmd.json +17 -0
- package/resources/locales/de/sheet.cmd.json +270 -16
- package/resources/locales/de/slicer.cmd.json +17 -0
- package/resources/locales/de/sparkline.cmd.json +301 -0
- package/resources/locales/de/table.cmd.json +13 -2
- package/resources/locales/de/ui.msg.json +358 -2
- package/resources/locales/de/workbook.cmd.json +8 -1
- package/resources/locales/en/chart.cmd.json +82 -0
- package/resources/locales/en/movable.cmd.json +68 -0
- package/resources/locales/en/picture.cmd.json +188 -0
- package/resources/locales/en/pivot.cmd.json +79 -0
- package/resources/locales/en/shape.cmd.json +17 -0
- package/resources/locales/en/sheet.cmd.json +283 -17
- package/resources/locales/en/slicer.cmd.json +17 -0
- package/resources/locales/en/sparkline.cmd.json +301 -0
- package/resources/locales/en/table.cmd.json +13 -2
- package/resources/locales/en/ui.msg.json +360 -2
- package/resources/locales/en/workbook.cmd.json +8 -1
- package/types/chart.d.ts +2 -0
- package/types/control.d.ts +2 -0
- package/types/group.d.ts +2 -0
- package/types/note.d.ts +2 -0
- package/types/picture.d.ts +2 -0
- package/types/shape.d.ts +2 -0
- package/types/slicer.d.ts +2 -0
- package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
- package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
- package/types/src/annotation/RangeAnnotations.d.ts +180 -0
- package/types/src/annotation/index.d.ts +4 -0
- package/types/src/autoFill/FillMenu.d.ts +2 -2
- package/types/src/autoFill/FillSeries.d.ts +2 -2
- package/types/src/border/StaticBorderRenderer.d.ts +18 -1
- package/types/src/border/useBorders.d.ts +95 -3
- package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
- package/types/src/cell/CellContent.d.ts +68 -0
- package/types/src/cell/CellControlContext.d.ts +37 -0
- package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
- package/types/src/cell/CellImageRenderer.d.ts +11 -0
- package/types/src/cell/CellRenderers.d.ts +190 -0
- package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
- package/types/src/cell/ColumnButton.d.ts +3 -3
- package/types/src/cell/CornerTriangle.d.ts +2 -1
- package/types/src/cell/OutlineButton.d.ts +123 -0
- package/types/src/cell/PivotButton.d.ts +55 -0
- package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
- package/types/src/cell/StaticCellRenderer.d.ts +3 -3
- package/types/src/cell/_DropdownFace.d.ts +29 -0
- package/types/src/cell/index.d.ts +10 -2
- package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
- package/types/src/cell/useInsertableCellControls.d.ts +25 -0
- package/types/src/chart/ChartCommands.d.ts +15 -0
- package/types/src/chart/ChartEditor.d.ts +12 -2
- package/types/src/chart/ChartElement.d.ts +122 -0
- package/types/src/chart/ChartKind.d.ts +7 -0
- package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
- package/types/src/chart/index.d.ts +2 -1
- package/types/src/chart/paint/_fills.d.ts +24 -0
- package/types/src/chart/paint/_graphics.d.ts +38 -0
- package/types/src/chart/paint/_mode.d.ts +6 -0
- package/types/src/chart/paint/echarts.d.ts +33 -0
- package/types/src/chart/paint/index.d.ts +12 -0
- package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
- package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
- package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
- package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
- package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
- package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
- package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
- package/types/src/checklist/ValueChecklist.d.ts +59 -18
- package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
- package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
- package/types/src/commands/ContextualToolbar.d.ts +19 -0
- package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
- package/types/src/commands/index.d.ts +1 -0
- package/types/src/comment/CommentCardRequest.d.ts +9 -9
- package/types/src/comment/index.d.ts +0 -1
- package/types/src/comment/useSheetComments.d.ts +2 -2
- package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
- package/types/src/context/WorksheetContext.d.ts +18 -0
- package/types/src/context/index.d.ts +1 -1
- package/types/src/control/FormControlRenderers.d.ts +22 -0
- package/types/src/editableLabel/EditableLabel.d.ts +3 -1
- package/types/src/editor/EditorCommands.d.ts +3 -3
- package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
- package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
- package/types/src/editor/SheetCellInput.d.ts +14 -0
- package/types/src/editor/SheetEditable.d.ts +6 -6
- package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
- package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
- package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
- package/types/src/editor/formulaAnchor.d.ts +12 -0
- package/types/src/editor/formulaPresentation.d.ts +4 -3
- package/types/src/editor/index.d.ts +2 -0
- package/types/src/editor/pickedReference.d.ts +3 -3
- package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
- package/types/src/editor/useFormulaHints.d.ts +3 -3
- package/types/src/editor/useFormulaInput.d.ts +6 -3
- package/types/src/editor/validationAlert.d.ts +24 -0
- package/types/src/form/FormulaInput.d.ts +5 -2
- package/types/src/form/useEditCommit.d.ts +23 -3
- package/types/src/form/useInputField.d.ts +2 -3
- package/types/src/frame/CommandContext.d.ts +101 -3
- package/types/src/group/GroupEditor.d.ts +25 -0
- package/types/src/index.d.ts +10 -1
- package/types/src/layer/BorderLayer.d.ts +5 -2
- package/types/src/layer/CellErrorLayer.d.ts +18 -7
- package/types/src/layer/CellFillLayer.d.ts +2 -2
- package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
- package/types/src/layer/CellInsertLayer.d.ts +71 -0
- package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
- package/types/src/layer/CommentCardLayer.d.ts +7 -9
- package/types/src/layer/CommentsLayer.d.ts +2 -2
- package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
- package/types/src/layer/ConditionalIcons.d.ts +4 -4
- package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
- package/types/src/layer/ContextMenuLayer.d.ts +2 -2
- package/types/src/layer/FreezeDragLines.d.ts +17 -0
- package/types/src/layer/GridFreezeLayer.d.ts +11 -0
- package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
- package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
- package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
- package/types/src/layer/HyperlinkLayer.d.ts +116 -0
- package/types/src/layer/MovableKindScope.d.ts +17 -0
- package/types/src/layer/PivotLayer.d.ts +47 -0
- package/types/src/layer/PivotToolbar.d.ts +29 -0
- package/types/src/layer/ProtectionLayer.d.ts +4 -5
- package/types/src/layer/RangeToolbar.d.ts +75 -0
- package/types/src/layer/ResizeIndicator.d.ts +11 -10
- package/types/src/layer/ResizeTooltip.d.ts +13 -0
- package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
- package/types/src/layer/SheetCellLayer.d.ts +15 -8
- package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
- package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
- package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
- package/types/src/layer/SheetLayers.d.ts +171 -0
- package/types/src/layer/SheetMovableLayer.d.ts +4 -3
- package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
- package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
- package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
- package/types/src/layer/SparklineLayer.d.ts +32 -0
- package/types/src/layer/SpillLayer.d.ts +2 -2
- package/types/src/layer/TableLayer.d.ts +6 -5
- package/types/src/layer/TableToolbar.d.ts +23 -0
- package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
- package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
- package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
- package/types/src/layer/_sheetBorders.d.ts +6 -0
- package/types/src/layer/_tableColor.d.ts +6 -0
- package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
- package/types/src/layer/cellTip.d.ts +13 -0
- package/types/src/layer/freezeDragState.d.ts +21 -0
- package/types/src/layer/index.d.ts +15 -0
- package/types/src/layer/resizeIndicatorState.d.ts +3 -1
- package/types/src/layer/useFreezeDrag.d.ts +22 -0
- package/types/src/layer/useNormalBorderLines.d.ts +15 -0
- package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
- package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
- package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
- package/types/src/layer/useTableHeaderCells.d.ts +2 -2
- package/types/src/layer/useValidationPicker.d.ts +3 -3
- package/types/src/layer/useVisibleTables.d.ts +2 -2
- package/types/src/layer/validationMark.d.ts +3 -3
- package/types/src/listener/index.d.ts +5 -0
- package/types/src/listener/useCell.d.ts +29 -0
- package/types/src/listener/useCellRange.d.ts +23 -0
- package/types/src/listener/useCellValue.d.ts +26 -0
- package/types/src/listener/useModelListener.d.ts +4 -4
- package/types/src/listener/useRangeListener.d.ts +13 -7
- package/types/src/listener/useRangeSnapshot.d.ts +35 -0
- package/types/src/listener/useTable.d.ts +26 -0
- package/types/src/movable/ConnectionSites.d.ts +18 -0
- package/types/src/movable/DefaultMovable.d.ts +8 -0
- package/types/src/movable/IMovableArea.d.ts +38 -0
- package/types/src/movable/MovableAdornment.d.ts +26 -0
- package/types/src/movable/MovableCommandGroups.d.ts +22 -0
- package/types/src/movable/MovableCommands.d.ts +8 -3
- package/types/src/movable/MovableControl.d.ts +80 -0
- package/types/src/movable/MovableFrame.d.ts +18 -16
- package/types/src/movable/MovableLayer.d.ts +30 -5
- package/types/src/movable/MovableRenderers.d.ts +210 -0
- package/types/src/movable/PlaceholderFrames.d.ts +11 -0
- package/types/src/movable/RotateHandle.d.ts +37 -0
- package/types/src/movable/connect.d.ts +16 -0
- package/types/src/movable/framePlacement.d.ts +72 -0
- package/types/src/movable/geometry.d.ts +61 -0
- package/types/src/movable/index.d.ts +9 -0
- package/types/src/movable/pressTarget.d.ts +20 -0
- package/types/src/movable/useFramePreview.d.ts +17 -0
- package/types/src/picker/cellPickerOpen.d.ts +3 -3
- package/types/src/picker/useCellPicker.d.ts +7 -5
- package/types/src/picture/PictureCommands.d.ts +20 -0
- package/types/src/picture/PictureKind.d.ts +7 -0
- package/types/src/picture/_pictureHyperlink.d.ts +13 -0
- package/types/src/picture/index.d.ts +0 -1
- package/types/src/picture/pictureCrop.d.ts +32 -0
- package/types/src/pivot/PivotAreas.d.ts +16 -0
- package/types/src/pivot/PivotChip.d.ts +33 -0
- package/types/src/pivot/PivotChipMenu.d.ts +74 -0
- package/types/src/pivot/PivotCommands.d.ts +24 -0
- package/types/src/pivot/PivotFieldList.d.ts +14 -0
- package/types/src/pivot/PivotFields.d.ts +47 -0
- package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
- package/types/src/pivot/PivotTablePane.d.ts +47 -0
- package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
- package/types/src/pivot/_pivotNew.d.ts +12 -0
- package/types/src/pivot/_pivotRegion.d.ts +14 -0
- package/types/src/pivot/index.d.ts +9 -0
- package/types/src/pivot/usePivotFields.d.ts +17 -0
- package/types/src/presence/PresenceCommands.d.ts +35 -0
- package/types/src/presence/PresenceHost.d.ts +58 -0
- package/types/src/presence/PresenceMessages.d.ts +42 -0
- package/types/src/presence/PresenceStore.d.ts +165 -0
- package/types/src/presence/PresenceTypes.d.ts +78 -0
- package/types/src/presence/index.d.ts +7 -0
- package/types/src/presence/usePresence.d.ts +20 -0
- package/types/src/richText/RichTextEditor.d.ts +2 -2
- package/types/src/selection/SelectionCommands.d.ts +2 -2
- package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
- package/types/src/shape/ConnectorControl.d.ts +46 -0
- package/types/src/shape/ShapeCommands.d.ts +11 -0
- package/types/src/shape/ShapeControl.d.ts +8 -0
- package/types/src/shape/ShapeEditor.d.ts +15 -2
- package/types/src/shape/ShapeGallery.d.ts +31 -0
- package/types/src/shape/ShapeHandles.d.ts +28 -0
- package/types/src/shape/ShapeKind.d.ts +7 -0
- package/types/src/shape/ShapeSVG.d.ts +22 -0
- package/types/src/shape/ShapeText.d.ts +17 -0
- package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
- package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
- package/types/src/shape/index.d.ts +3 -1
- package/types/src/shape/shapeFrame.d.ts +50 -0
- package/types/src/shape/shapeStyle.d.ts +82 -0
- package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
- package/types/src/sheet/IWorksheetElement.d.ts +289 -0
- package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
- package/types/src/sheet/SheetCommands.d.ts +18 -3
- package/types/src/sheet/SheetKindIcon.d.ts +14 -0
- package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
- package/types/src/sheet/SheetPanels.d.ts +11 -0
- package/types/src/sheet/SheetScrollbar.d.ts +4 -13
- package/types/src/sheet/TopLeftCorner.d.ts +2 -2
- package/types/src/sheet/WorksheetElement.d.ts +12 -0
- package/types/src/sheet/_freezeAt.d.ts +10 -0
- package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
- package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
- package/types/src/sheet/circularReferences.d.ts +4 -4
- package/types/src/sheet/index.d.ts +5 -2
- package/types/src/sheet/useCycleHighlight.d.ts +2 -2
- package/types/src/slicer/SlicerCommands.d.ts +10 -0
- package/types/src/slicer/SlicerEditor.d.ts +8 -2
- package/types/src/slicer/SlicerKind.d.ts +7 -0
- package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
- package/types/src/slicer/index.d.ts +2 -1
- package/types/src/slicer/slicerStyles.d.ts +32 -0
- package/types/src/sparkline/PictureCache.d.ts +37 -0
- package/types/src/sparkline/SparklineCommands.d.ts +23 -0
- package/types/src/sparkline/SparklinePictures.d.ts +7 -0
- package/types/src/sparkline/paint/_drawing.d.ts +24 -0
- package/types/src/sparkline/paint/echarts.d.ts +8 -0
- package/types/src/sparkline/paint/index.d.ts +8 -0
- package/types/src/tabStrip/SheetTab.d.ts +1 -1
- package/types/src/tabStrip/Sortable.d.ts +5 -5
- package/types/src/tabStrip/TabStrip.d.ts +13 -6
- package/types/src/tabStrip/TabStripItem.d.ts +15 -13
- package/types/src/table/TableCommands.d.ts +2 -2
- package/types/src/taskPane/CellControlPane.d.ts +15 -0
- package/types/src/taskPane/MovablePane.d.ts +15 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
- package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
- package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
- package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
- package/types/src/taskPane/_paneReasons.d.ts +7 -0
- package/types/src/taskPane/index.d.ts +3 -0
- package/types/src/taskPane/useTaskPane.d.ts +6 -3
- package/types/src/theme/ExplicitTokens.d.ts +18 -0
- package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
- package/types/src/theme/ThemeRootStyles.d.ts +31 -0
- package/types/src/theme/ThemeState.d.ts +2 -2
- package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
- package/types/src/theme/buildTokensCSS.d.ts +15 -0
- package/types/src/theme/index.d.ts +2 -4
- package/types/src/theme/useAppColorScheme.d.ts +4 -1
- package/types/src/theme/useGridColorScheme.d.ts +9 -4
- package/types/src/theme/useSystemColors.d.ts +1 -15
- package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
- package/types/src/workbook/DefaultRenderers.d.ts +5 -4
- package/types/src/workbook/IWorkbookElement.d.ts +176 -30
- package/types/src/workbook/WorkbookCommands.d.ts +6 -1
- package/types/src/workbook/WorkbookStrip.d.ts +14 -5
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
- package/browser/cjs/index.cjs +0 -42
- package/browser/esm/CwXbsCWTrl3QB1t6.mjs +0 -6286
- package/node/esm/CZc8rKcLzArmqJz2.mjs +0 -9
- package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-template.json.d.ts +0 -9
- package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-template.json.d.ts +0 -9
- package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-template.json.d.ts +0 -9
- package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-template.json.d.ts +0 -9
- package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
- package/types/src/chart/templates/pie-template.json.d.ts +0 -9
- package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
- package/types/src/context/SheetContext.d.ts +0 -18
- package/types/src/movable/MoveableBundle.d.ts +0 -4
- package/types/src/sheet/ISheetElement.d.ts +0 -258
- package/types/src/sheet/SheetElement.d.ts +0 -15
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { Bounds, Point } from '@sheetxl/utils';
|
|
2
|
+
import { IMovable } from '@sheetxl/sdk';
|
|
3
|
+
import { IGridPane } from '@sheetxl/grid-react';
|
|
4
|
+
import { ResizeDirection } from './geometry';
|
|
5
|
+
/** Where a movable's frame sits in a pane: its pane box and its turn about the box's center. */
|
|
6
|
+
export interface FramePlacement {
|
|
7
|
+
left: number;
|
|
8
|
+
top: number;
|
|
9
|
+
width: number;
|
|
10
|
+
height: number;
|
|
11
|
+
/** Degrees, clockwise. */
|
|
12
|
+
rotation: number;
|
|
13
|
+
/** How the content is mirrored within the box. */
|
|
14
|
+
flip: IMovable.Flip;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* An in-flight gesture's view of one movable, drawn in place of the model until the gesture
|
|
18
|
+
* commits. What it leaves out is read from the model.
|
|
19
|
+
*/
|
|
20
|
+
export interface MovablePreview {
|
|
21
|
+
/** The unrotated frame, absolute. */
|
|
22
|
+
bounds?: Bounds;
|
|
23
|
+
/** Degrees, clockwise. */
|
|
24
|
+
rotation?: number;
|
|
25
|
+
/** How the content is mirrored within the frame. */
|
|
26
|
+
flip?: IMovable.Flip;
|
|
27
|
+
/** What the gesture holds — a handle, or for a move the point of the frame it was grabbed by. */
|
|
28
|
+
grip?: MovableGrip;
|
|
29
|
+
/** What the content draws in place of its own until the gesture commits. */
|
|
30
|
+
content?: MovableContentPreview;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* A content's own state as a gesture previews it: a shape's adjust values while one of its handles
|
|
34
|
+
* is dragged, or the route a glued connector takes while the shape it is glued to moves.
|
|
35
|
+
*/
|
|
36
|
+
export interface MovableContentPreview {
|
|
37
|
+
/** A shape's preset, as `IShape.getShapeType` answers. */
|
|
38
|
+
shapeType?: string;
|
|
39
|
+
/** A shape's adjust values; `null` for the preset's defaults. */
|
|
40
|
+
adjustments?: Readonly<Record<string, number>> | null;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* What an in-flight gesture holds, so the readout can sit by it wherever the frame has turned: a resize
|
|
44
|
+
* handle by its direction, the rotate handle by its distance from the frame's center (pane px) and
|
|
45
|
+
* whether it is drawn below the frame (mirrored top to bottom), a move by where it was grabbed — the
|
|
46
|
+
* press's offset from the unrotated frame's top-left (pane px), which a move never changes, so it stays
|
|
47
|
+
* under the pointer.
|
|
48
|
+
*/
|
|
49
|
+
export type MovableGrip = {
|
|
50
|
+
kind: 'resize';
|
|
51
|
+
direction: ResizeDirection;
|
|
52
|
+
} | {
|
|
53
|
+
kind: 'rotate';
|
|
54
|
+
radius: number;
|
|
55
|
+
below: boolean;
|
|
56
|
+
} | {
|
|
57
|
+
kind: 'move';
|
|
58
|
+
at: Point;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* The placement of a movable's frame in `pane`, from the drag preview when there is one, else the
|
|
62
|
+
* model. The frame and everything drawn in register with it (adornments) use this, so they cannot
|
|
63
|
+
* disagree.
|
|
64
|
+
*
|
|
65
|
+
* @remarks
|
|
66
|
+
* The frame's corner sits on a device pixel, as Excel places a drawing and as the grid places a
|
|
67
|
+
* fill: a drawing that lands its lines on the device grid (a shape's thin strokes) then needs only
|
|
68
|
+
* the zoom and the device pixel ratio to do so, and the frame scrolls under it by whole device
|
|
69
|
+
* pixels. The size is not snapped; the drawing's zoom stays exact.
|
|
70
|
+
*/
|
|
71
|
+
export declare const framePlacement: (movable: IMovable, pane: IGridPane, preview?: MovablePreview | null) => FramePlacement;
|
|
72
|
+
//# sourceMappingURL=framePlacement.d.ts.map
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { Bounds } from '@sheetxl/utils';
|
|
2
|
+
/**
|
|
3
|
+
* Which handle a resize drags, per axis: `-1` the left or top edge, `1` the right or bottom edge,
|
|
4
|
+
* `0` neither (an edge handle on the other axis).
|
|
5
|
+
*/
|
|
6
|
+
export type ResizeDirection = readonly [number, number];
|
|
7
|
+
/** What dragging a resize handle made of a frame. */
|
|
8
|
+
export interface ResizedFrame {
|
|
9
|
+
/** The unrotated frame, turned by the same rotation about its own center as the start frame. */
|
|
10
|
+
bounds: Bounds;
|
|
11
|
+
/**
|
|
12
|
+
* Per axis, whether the dragged side was pulled through the held one, so the frame now lies on
|
|
13
|
+
* the other side of it: what mirrors the content, as in Excel.
|
|
14
|
+
*/
|
|
15
|
+
crossed: readonly [boolean, boolean];
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* The frame after dragging a resize handle, with the opposite edge or corner held still on screen.
|
|
19
|
+
*
|
|
20
|
+
* @param start - The unrotated frame when the drag started.
|
|
21
|
+
* @param direction - The handle being dragged.
|
|
22
|
+
* @param dist - How much the frame has grown along its own (unrotated) axes, positive when larger,
|
|
23
|
+
* whichever side is dragged. An axis the handle does not drag is ignored.
|
|
24
|
+
* @param rotation - Degrees clockwise the frame is turned about its center.
|
|
25
|
+
* @param keepAspect - Keep `start`'s aspect ratio. Only a corner drag keeps it.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* A handle dragged through the held side keeps going: the frame is then the box between the held
|
|
29
|
+
* side and the pointer, and that axis is reported crossed. The frame's size is never negative.
|
|
30
|
+
*/
|
|
31
|
+
export declare const resizeFrame: (start: Bounds, direction: ResizeDirection, dist: readonly [number, number], rotation: number, keepAspect: boolean) => ResizedFrame;
|
|
32
|
+
/**
|
|
33
|
+
* How much a resize handle's drag grows its frame, the `dist` that `resizeFrame` takes.
|
|
34
|
+
*
|
|
35
|
+
* @param direction - The handle being dragged.
|
|
36
|
+
* @param delta - How far the pointer is from the press, on screen.
|
|
37
|
+
* @param rotation - Degrees clockwise the frame is turned about its center.
|
|
38
|
+
* @returns The growth along the frame's own axes, positive when larger.
|
|
39
|
+
*/
|
|
40
|
+
export declare const resizeGrowth: (direction: ResizeDirection, delta: readonly [number, number], rotation: number) => [number, number];
|
|
41
|
+
/** The step a rotation snaps to while Shift is held, in degrees. */
|
|
42
|
+
export declare const ROTATION_SNAP = 15;
|
|
43
|
+
/**
|
|
44
|
+
* A rotation in `[0, 360)`, optionally snapped to the nearest multiple of `snap` degrees.
|
|
45
|
+
*/
|
|
46
|
+
export declare const normalizeRotation: (degrees: number, snap?: number) => number;
|
|
47
|
+
/**
|
|
48
|
+
* The angle, in degrees clockwise on screen, a pointer has swept about `center` since `press`,
|
|
49
|
+
* in `(-180, 180]`.
|
|
50
|
+
*/
|
|
51
|
+
export declare const sweptAngle: (center: {
|
|
52
|
+
x: number;
|
|
53
|
+
y: number;
|
|
54
|
+
}, press: {
|
|
55
|
+
x: number;
|
|
56
|
+
y: number;
|
|
57
|
+
}, pointer: {
|
|
58
|
+
x: number;
|
|
59
|
+
y: number;
|
|
60
|
+
}) => number;
|
|
61
|
+
//# sourceMappingURL=geometry.d.ts.map
|
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
export * from './IMovableArea';
|
|
2
2
|
export * from './MovableLayer';
|
|
3
|
+
export * from './MovableAdornment';
|
|
4
|
+
export * from './framePlacement';
|
|
5
|
+
export * from './connect';
|
|
6
|
+
export * from './MovableControl';
|
|
7
|
+
export * from './pressTarget';
|
|
3
8
|
export * from './MovableEdit';
|
|
4
9
|
export * from './EmptyFrame';
|
|
5
10
|
export * from './TextBox';
|
|
11
|
+
export * from './MovableRenderers';
|
|
12
|
+
export * from './DefaultMovable';
|
|
13
|
+
export * from './MovableCommandGroups';
|
|
14
|
+
export * from './ConnectionSites';
|
|
6
15
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { IMovable } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* The attribute a container renderer puts on each member's box (with the member's id), so a press
|
|
4
|
+
* inside a group's frame finds the member it landed on.
|
|
5
|
+
*/
|
|
6
|
+
export declare const MEMBER_ATTRIBUTE = "data-movable-id";
|
|
7
|
+
/** The movable at the top of `movable`'s parent chain: itself when it has no parent. */
|
|
8
|
+
export declare const rootOf: (movable: IMovable) => IMovable;
|
|
9
|
+
/**
|
|
10
|
+
* The movable a press on `root`'s frame selects, as Excel's two-step: the first press selects the
|
|
11
|
+
* root; a press while the root is selected selects the member under the pointer; a press while a
|
|
12
|
+
* member is selected selects the member at that depth under the pointer, or one deeper when the
|
|
13
|
+
* selected member is the one pressed into.
|
|
14
|
+
*
|
|
15
|
+
* @param root The movable whose frame was pressed.
|
|
16
|
+
* @param target The element the press landed on.
|
|
17
|
+
* @param frame The frame's element, where the walk up stops.
|
|
18
|
+
*/
|
|
19
|
+
export declare const resolvePressedMovable: (root: IMovable, target: Element | null, frame: Element) => IMovable;
|
|
20
|
+
//# sourceMappingURL=pressTarget.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { IMovable } from '@sheetxl/sdk';
|
|
2
|
+
import { MovableContentPreview } from './framePlacement';
|
|
3
|
+
/**
|
|
4
|
+
* The unzoomed, unrotated size a movable is drawn at: its frame on the canvas (for a member of a
|
|
5
|
+
* group, already mapped through the group's scale, so its line keeps its width), or the size an
|
|
6
|
+
* in-flight resize has it at, so its content is laid out again as the pointer moves rather than
|
|
7
|
+
* stretched, as Excel draws it. With it, the turn the frame is drawn at, and what an in-flight gesture
|
|
8
|
+
* draws the content as: adjust values a handle drag has it at, or the route a glued connector is
|
|
9
|
+
* taking.
|
|
10
|
+
*/
|
|
11
|
+
export declare const useFramePreview: (movable: IMovable | undefined) => {
|
|
12
|
+
width: number;
|
|
13
|
+
height: number;
|
|
14
|
+
rotation: number;
|
|
15
|
+
content: MovableContentPreview | null;
|
|
16
|
+
};
|
|
17
|
+
//# sourceMappingURL=useFramePreview.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
2
2
|
/** Record that `sheet`'s picker opened, or (`null`) that the open one closed. */
|
|
3
|
-
export declare const setCellPickerOpen: (sheet:
|
|
3
|
+
export declare const setCellPickerOpen: (sheet: IWorksheet | null) => void;
|
|
4
4
|
/** Whether `sheet` has a cell picker open (reactive). */
|
|
5
|
-
export declare const useCellPickerOpen: (sheet:
|
|
5
|
+
export declare const useCellPickerOpen: (sheet: IWorksheet) => boolean;
|
|
6
6
|
//# sourceMappingURL=cellPickerOpen.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import { CellCoords } from '@sheetxl/utils';
|
|
3
|
-
import {
|
|
2
|
+
import { CellCoords, MaybePromise } from '@sheetxl/utils';
|
|
3
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
4
4
|
import { GridAnchor, IEditable } from '@sheetxl/grid-react';
|
|
5
5
|
import { PickerItem } from './PickerPanel';
|
|
6
6
|
/**
|
|
@@ -10,7 +10,7 @@ import { PickerItem } from './PickerPanel';
|
|
|
10
10
|
*/
|
|
11
11
|
export interface CellPickerOptions {
|
|
12
12
|
/** The sheet the cell is on: its `Normal` font, its current text, and the open flag. */
|
|
13
|
-
sheet:
|
|
13
|
+
sheet: IWorksheet;
|
|
14
14
|
/**
|
|
15
15
|
* The editable a default choice is entered through — the same path as typing the item's text, so
|
|
16
16
|
* the value coerces and formats as a typed one does. Not needed when {@link onChoose} is given.
|
|
@@ -73,9 +73,11 @@ export interface CellPicker {
|
|
|
73
73
|
* Enter `text` into `cell` as a typed entry: an edit session seeded with the text and committed at
|
|
74
74
|
* once, so the value coerces, formats and is checked exactly as if it had been typed.
|
|
75
75
|
*
|
|
76
|
-
* @returns Whether the entry was written
|
|
76
|
+
* @returns Whether the entry was written, or a promise of that while the entry is checked. A refused
|
|
77
|
+
* entry leaves the cell as it was; a pick that opened its own edit closes it, and the alert it raised
|
|
78
|
+
* stays up.
|
|
77
79
|
*/
|
|
78
|
-
export declare const commitListPick: (editable: IEditable<any, string, any>, cell: CellCoords, text: string) => boolean
|
|
80
|
+
export declare const commitListPick: (editable: IEditable<any, string, any>, cell: CellCoords, text: string) => MaybePromise<boolean>;
|
|
79
81
|
/**
|
|
80
82
|
* A **cell picker** — a menu through the shared float stack (so it gets the portal, stacking,
|
|
81
83
|
* light-dismiss and Escape every other popup in the app has), positioned by the grid on the cell it is
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Command } from '@sheetxl/utils-react';
|
|
2
|
+
import { MovableKindCommandData } from '../movable';
|
|
3
|
+
/** Excel's Crop > Aspect Ratio, by command: width over height. */
|
|
4
|
+
export declare const PictureCropAspects: Readonly<Record<string, readonly [width: number, height: number]>>;
|
|
5
|
+
/**
|
|
6
|
+
* The picture kind's commands, for the active picture. Chrome is the `picture` catalog.
|
|
7
|
+
*
|
|
8
|
+
* Change Picture shows another image in the same frame, as Excel's does: from a file
|
|
9
|
+
* (`changePictureFromFile`, a file dialog) or from the web (`changePictureFromURL`, an input
|
|
10
|
+
* dialog). The image is read before the picture takes it, so a bad address or an unreadable file
|
|
11
|
+
* changes nothing. Dialog-driven and self-committing, so `noTransaction` / `noRepeat`.
|
|
12
|
+
*
|
|
13
|
+
* The crop commands are Excel's Crop menu: Crop to Shape takes what a shape gallery entry states,
|
|
14
|
+
* Aspect Ratio frames the picture at a ratio, and Fill and Fit place the image in the frame. A picture
|
|
15
|
+
* that locks its crop (`noCrop`) offers none of them.
|
|
16
|
+
*
|
|
17
|
+
* The link commands add, change, follow and remove the hyperlink a click on the picture follows.
|
|
18
|
+
*/
|
|
19
|
+
export declare const contributePictureCommands: Command.DynamicCommandContributor<MovableKindCommandData>;
|
|
20
|
+
//# sourceMappingURL=PictureCommands.d.ts.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { MovableRendererModule } from '../movable/MovableRenderers';
|
|
2
|
+
/**
|
|
3
|
+
* The picture kind, as the renderer registry loads it: one module, so a failed fetch can be
|
|
4
|
+
* imported again whole.
|
|
5
|
+
*/
|
|
6
|
+
export declare const PictureKind: MovableRendererModule;
|
|
7
|
+
//# sourceMappingURL=PictureKind.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { IPicture, IWorksheet } from '@sheetxl/sdk';
|
|
2
|
+
import { IReactNotifier } from '@sheetxl/utils-react';
|
|
3
|
+
/**
|
|
4
|
+
* The surface state that holds the linked picture under the pointer: a frame takes the pointer before
|
|
5
|
+
* the cells do, so the picture says it is hovered and the hyperlink layer draws its card.
|
|
6
|
+
*/
|
|
7
|
+
export declare const HOVERED_PICTURE_LINK = "hovered-picture-link";
|
|
8
|
+
/**
|
|
9
|
+
* Opens the hyperlink dialog on a picture. There is no text to show, so the dialog offers none; a link
|
|
10
|
+
* emptied there is removed. The dialog is read-only for a picture that cannot change.
|
|
11
|
+
*/
|
|
12
|
+
export declare const showPictureHyperlink: (picture: IPicture, sheet: IWorksheet, notifier: IReactNotifier | undefined) => void;
|
|
13
|
+
//# sourceMappingURL=_pictureHyperlink.d.ts.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { Bounds, Size } from '@sheetxl/utils';
|
|
2
|
+
import { IFill } from '@sheetxl/sdk';
|
|
3
|
+
/**
|
|
4
|
+
* Excel's Crop > Fill: the image covers the frame, keeping its proportions and centered. What
|
|
5
|
+
* overflows the frame is cropped; the frame stays.
|
|
6
|
+
*/
|
|
7
|
+
export declare const fillCrop: (frame: Size, natural: Size) => IFill.RectInsets;
|
|
8
|
+
/**
|
|
9
|
+
* Excel's Crop > Fit: the whole image shows in the frame, keeping its proportions and centered. Where
|
|
10
|
+
* it falls short of the frame the crop is negative; the frame stays.
|
|
11
|
+
*/
|
|
12
|
+
export declare const fitCrop: (frame: Size, natural: Size) => IFill.RectInsets;
|
|
13
|
+
/**
|
|
14
|
+
* Excel's Crop > Aspect Ratio: the largest frame of that ratio inside the frame, about the same center.
|
|
15
|
+
* The image keeps its scale and position on the sheet, so the crop takes up what the frame gave up.
|
|
16
|
+
*
|
|
17
|
+
* @param bounds The frame.
|
|
18
|
+
* @param crop The crop now.
|
|
19
|
+
* @param ratio Width over height.
|
|
20
|
+
*/
|
|
21
|
+
export declare const aspectCrop: (bounds: Bounds, crop: IFill.RectInsets, ratio: number) => {
|
|
22
|
+
bounds: Bounds;
|
|
23
|
+
crop: IFill.RectInsets;
|
|
24
|
+
};
|
|
25
|
+
/** Where the whole image lies when `crop` of it covers a box, in percentages of the box. */
|
|
26
|
+
export declare const imagePlacement: (crop: IFill.RectInsets | undefined) => {
|
|
27
|
+
left: string;
|
|
28
|
+
top: string;
|
|
29
|
+
width: string;
|
|
30
|
+
height: string;
|
|
31
|
+
};
|
|
32
|
+
//# sourceMappingURL=pictureCrop.d.ts.map
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
/** Props for {@link PivotAreas}. */
|
|
3
|
+
export interface PivotAreasProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* The four areas, Excel's Filters, Columns, Rows and Values, each a list of chips in the table's
|
|
7
|
+
* order. A chip drags within its area or to another one, and its ▾ menu (also a right-click, or
|
|
8
|
+
* Shift+F10) moves it, takes it off, or changes a value's function. A focused chip moves with
|
|
9
|
+
* Alt+↑ / Alt+↓, comes off the table with Delete, and is renamed with F2 or a double-click; Space or
|
|
10
|
+
* Enter picks it up to move with the arrow keys.
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
* Goes inside a {@link PivotDragContext}.
|
|
14
|
+
*/
|
|
15
|
+
export declare const PivotAreas: (props: PivotAreasProps) => React.ReactElement;
|
|
16
|
+
//# sourceMappingURL=PivotAreas.d.ts.map
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PivotFieldsModel } from './PivotFieldsModel';
|
|
3
|
+
/** Props for {@link PivotChip}. */
|
|
4
|
+
export interface PivotChipProps extends React.HTMLAttributes<HTMLElement> {
|
|
5
|
+
/** What the chip shows. */
|
|
6
|
+
chip: PivotFieldsModel.Chip;
|
|
7
|
+
/** The area it is in: the values' slot says which way it lays the values out. */
|
|
8
|
+
area: PivotFieldsModel.Area;
|
|
9
|
+
/** Drawn as the copy that follows the pointer during a drag. */
|
|
10
|
+
overlay?: boolean;
|
|
11
|
+
/** The original, while its copy is dragged. */
|
|
12
|
+
dragging?: boolean;
|
|
13
|
+
/** Spread on the caption, which takes the chip's focus and starts its drag. */
|
|
14
|
+
propsCaption?: React.HTMLAttributes<HTMLElement> & {
|
|
15
|
+
ref?: React.Ref<HTMLElement>;
|
|
16
|
+
} & Record<`data-${string}`, string>;
|
|
17
|
+
/** Drawn at the chip's end: its ▾. */
|
|
18
|
+
menuButton?: React.ReactNode;
|
|
19
|
+
/** An input over the caption, to rename the chip. */
|
|
20
|
+
renaming?: boolean;
|
|
21
|
+
/** The name typed, when renaming ends; `null` when it was given up. */
|
|
22
|
+
onRename?: (name: string | null) => void;
|
|
23
|
+
ref?: React.Ref<HTMLElement>;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* A field in an area: its caption (a value's reads `Sum of Sales`), a mark when the field is
|
|
27
|
+
* filtered, and its ▾. `Σ Values` says whether it lays the values out as columns or as rows.
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Presentational: {@link PivotAreas} makes it draggable and gives it its keys and its menu.
|
|
31
|
+
*/
|
|
32
|
+
export declare const PivotChip: (props: PivotChipProps) => React.ReactElement;
|
|
33
|
+
//# sourceMappingURL=PivotChip.d.ts.map
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { FloatReference } from '@sheetxl/utils-react';
|
|
3
|
+
import { PivotMenuRenderProps } from '../workbook/IWorkbookElement';
|
|
4
|
+
import { PivotFieldsModel } from './PivotFieldsModel';
|
|
5
|
+
/** An entry of a chip's menu. */
|
|
6
|
+
export interface PivotChipMenuItem {
|
|
7
|
+
/** Names the entry: `moveUp`, `moveTo.row`, `function.sum`, `remove`. */
|
|
8
|
+
readonly key: string;
|
|
9
|
+
/** Translated. */
|
|
10
|
+
readonly label: string;
|
|
11
|
+
/** Set on a choice, a value's function: whether it is the one in effect. */
|
|
12
|
+
readonly checked?: boolean;
|
|
13
|
+
readonly disabled?: boolean;
|
|
14
|
+
/** Closes the menu and runs the entry. */
|
|
15
|
+
readonly run: () => void;
|
|
16
|
+
}
|
|
17
|
+
/** What a chip menu renderer ({@link PivotDragContextProps.renderMenu}) is handed. */
|
|
18
|
+
export interface PivotChipMenuRenderProps {
|
|
19
|
+
readonly chip: PivotFieldsModel.Chip;
|
|
20
|
+
readonly area: PivotFieldsModel.Area;
|
|
21
|
+
/** The entries, in groups; draw a divider between two groups. */
|
|
22
|
+
readonly groups: readonly (readonly PivotChipMenuItem[])[];
|
|
23
|
+
/** The menu's float. */
|
|
24
|
+
readonly floatReference: FloatReference;
|
|
25
|
+
}
|
|
26
|
+
/** The window a value's *Value settings…* opens (`showWindow`), given a {@link CommandContext.PivotValueSettings}. */
|
|
27
|
+
export declare const PIVOT_VALUE_SETTINGS_WINDOW = "pivotValueSettings";
|
|
28
|
+
/** A chip and where it is. */
|
|
29
|
+
export interface ChipPlace {
|
|
30
|
+
chip: PivotFieldsModel.Chip;
|
|
31
|
+
area: PivotFieldsModel.Area;
|
|
32
|
+
index: number;
|
|
33
|
+
/** How many chips its area has. */
|
|
34
|
+
count: number;
|
|
35
|
+
}
|
|
36
|
+
/** What a chip's entries act through. */
|
|
37
|
+
export interface ChipMenuActions {
|
|
38
|
+
model: PivotFieldsModel;
|
|
39
|
+
run: (gesture: Promise<void>) => void;
|
|
40
|
+
t: (key: string) => string;
|
|
41
|
+
/** Closes the menu. */
|
|
42
|
+
close: () => void;
|
|
43
|
+
/** Handed the id a moved chip will have, when it keeps one. */
|
|
44
|
+
focus: (id: string) => void;
|
|
45
|
+
/** Opens a value's settings. */
|
|
46
|
+
openValueSettings: (value: string) => void;
|
|
47
|
+
/** Opens a field's sort and filter; `null` when the host has none. */
|
|
48
|
+
openFilter: ((field: string) => void) | null;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* A chip's menu entries: a value's functions, its moves along its area, its moves to the other
|
|
52
|
+
* areas, a field's sort and filter, Remove, and a value's settings.
|
|
53
|
+
*/
|
|
54
|
+
export declare const chipMenuGroups: (place: ChipPlace, actions: ChipMenuActions) => PivotChipMenuItem[][];
|
|
55
|
+
/** Options for {@link useChipMenu}. */
|
|
56
|
+
export interface ChipMenuOptions {
|
|
57
|
+
place: ChipPlace;
|
|
58
|
+
model: PivotFieldsModel;
|
|
59
|
+
run: (gesture: Promise<void>) => void;
|
|
60
|
+
/** As {@link PivotDragContextProps.renderMenu}. */
|
|
61
|
+
renderMenu: ((props: PivotChipMenuRenderProps) => React.ReactNode) | null | undefined;
|
|
62
|
+
/** As {@link PivotDragContextProps.renderFilter}. */
|
|
63
|
+
renderFilter: ((props: PivotMenuRenderProps) => React.ReactNode) | null | undefined;
|
|
64
|
+
focus: (id: string) => void;
|
|
65
|
+
}
|
|
66
|
+
/** A chip's menu: the ▾ that opens it, and `open` for the chip's own ways in (right-click, Shift+F10). */
|
|
67
|
+
export interface ChipMenu {
|
|
68
|
+
/** `null` when the host renders no chip menus. */
|
|
69
|
+
button: React.ReactElement | null;
|
|
70
|
+
open: () => void;
|
|
71
|
+
}
|
|
72
|
+
/** The ▾ menu of one chip, in the float stack, anchored to its button. */
|
|
73
|
+
export declare const useChipMenu: (options: ChipMenuOptions) => ChipMenu;
|
|
74
|
+
//# sourceMappingURL=PivotChipMenu.d.ts.map
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { RemoveListener, UndoManager } from '@sheetxl/utils';
|
|
2
|
+
import { IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
import { Command, IReactNotifier } from '@sheetxl/utils-react';
|
|
4
|
+
/** Options for {@link contributePivotCommands}. */
|
|
5
|
+
export interface ContributePivotCommandsOptions {
|
|
6
|
+
/** Busy + error UI for the transactional middleware. */
|
|
7
|
+
notifier?: IReactNotifier;
|
|
8
|
+
/** Undo manager the sheet records into — enables F4 / redo-as-repeat. */
|
|
9
|
+
manager?: UndoManager;
|
|
10
|
+
}
|
|
11
|
+
/** The single `data` bundle {@link contributePivotCommands} takes (the `DynamicCommandContributor` shape). */
|
|
12
|
+
export interface PivotCommandData extends ContributePivotCommandsOptions {
|
|
13
|
+
sheet: IWorksheet | null;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* **Pivot table command behavior**: which parts of the style of the pivot table the active cell is
|
|
17
|
+
* in show. The `pivot` scope's behavior (chrome in the catalog, `pivot.cmd.json`); the ops and the
|
|
18
|
+
* PivotTable tab are contributed only while the active cell is in a pivot table, as the table
|
|
19
|
+
* scope's are ({@link contributeTableCommands}). The style itself (`formatPivotStyle`) is a `sheet`
|
|
20
|
+
* command: the pivot table toolbar's gallery opens on the press that puts the active cell in the
|
|
21
|
+
* table, before this scope's ops are contributed.
|
|
22
|
+
*/
|
|
23
|
+
export declare function contributePivotCommands(contribution: Command.CommandContribution, data: PivotCommandData): RemoveListener;
|
|
24
|
+
//# sourceMappingURL=PivotCommands.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
/** Props for {@link PivotFieldList}. */
|
|
3
|
+
export interface PivotFieldListProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* The source's fields, a search box over them, and a box to tick for each: a tick places the field
|
|
7
|
+
* by what it holds (numbers to the values, anything else to the rows), an untick takes it off the
|
|
8
|
+
* table. Each field shows what it holds and whether it is filtered, and drags into an area.
|
|
9
|
+
*
|
|
10
|
+
* @remarks
|
|
11
|
+
* Goes inside a {@link PivotDragContext}. A chip dropped on the list comes off the table.
|
|
12
|
+
*/
|
|
13
|
+
export declare const PivotFieldList: (props: PivotFieldListProps) => React.ReactElement;
|
|
14
|
+
//# sourceMappingURL=PivotFieldList.d.ts.map
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PivotFieldsState } from './usePivotFields';
|
|
3
|
+
import { PivotChipMenuRenderProps } from './PivotChipMenu';
|
|
4
|
+
import { PivotMenuRenderProps } from '../workbook/IWorkbookElement';
|
|
5
|
+
/** Props for {@link PivotDragContext}. */
|
|
6
|
+
export interface PivotDragContextProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
7
|
+
/** The table, from {@link usePivotFields}. */
|
|
8
|
+
fields: PivotFieldsState;
|
|
9
|
+
/** A gesture the table refused; it changed nothing. */
|
|
10
|
+
onError?: (error: unknown) => void;
|
|
11
|
+
/**
|
|
12
|
+
* The menu a chip's ▾ opens. `null` for chips with no menu.
|
|
13
|
+
* @defaultValue a plain list of the chip's entries
|
|
14
|
+
*/
|
|
15
|
+
renderMenu?: ((props: PivotChipMenuRenderProps) => React.ReactNode) | null;
|
|
16
|
+
/**
|
|
17
|
+
* A field's sort and filter, which its chip's *Sort and filter…* opens: the pivot field menu, as
|
|
18
|
+
* the workbook's `renderPivotMenu` draws it at a field's button in the table. Absent or `null`, the
|
|
19
|
+
* menu leaves the entry out.
|
|
20
|
+
*/
|
|
21
|
+
renderFilter?: ((props: PivotMenuRenderProps) => React.ReactNode) | null;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* The drag and drop between a {@link PivotFieldList} and {@link PivotAreas}: both go inside it, laid
|
|
25
|
+
* out however the host likes.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
* - A field dropped in an area goes there, before the chip it is dropped on or after the last.
|
|
29
|
+
* - A chip dropped on the field list, or outside this element, comes off the table.
|
|
30
|
+
* - A drop elsewhere inside this element, between the areas, does nothing.
|
|
31
|
+
*/
|
|
32
|
+
export declare const PivotDragContext: (props: PivotDragContextProps) => React.ReactElement;
|
|
33
|
+
/** Props for {@link PivotFields}. */
|
|
34
|
+
export interface PivotFieldsProps extends Omit<PivotDragContextProps, 'children'> {
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* A pivot table's field list over its four areas, as Excel's PivotTable Fields pane lays them out:
|
|
38
|
+
* tick a field to place it by what it holds, drag fields and chips between the areas, and move a
|
|
39
|
+
* focused chip with Alt+↑ / Alt+↓ or take it off with Delete.
|
|
40
|
+
*
|
|
41
|
+
* @remarks
|
|
42
|
+
* Needs no sheet, selection or task pane: a host with no grid mounts it beside its own view of the
|
|
43
|
+
* table. For another layout, put {@link PivotFieldList} and {@link PivotAreas} in a
|
|
44
|
+
* {@link PivotDragContext} directly.
|
|
45
|
+
*/
|
|
46
|
+
export declare const PivotFields: (props: PivotFieldsProps) => React.ReactElement;
|
|
47
|
+
//# sourceMappingURL=PivotFields.d.ts.map
|