@univerjs/sheets-ui v0.1.17 • Docs
@univerjs/sheets-ui
Enumerations
| Enumeration | Description |
|---|---|
| APPLY_TYPE | - |
| COPY_TYPE | - |
| CellAlertType | - |
| DATA_TYPE | - |
| JumpOver | - |
| SHEET_VIEW_KEY | Copyright 2023-present DreamNum Inc. |
| SheetMenuPosition | - |
| SheetsUIPart | Copyright 2023-present DreamNum Inc. |
| VIEWPORT_KEY | - |
Classes
Interfaces
| Interface | Description |
|---|---|
| IAutoFillLocation | - |
| IAutoFillRule | - |
| IAutoFillService | - |
| ICanvasPopup | - |
| ICellAlert | - |
| ICellEditorManagerService | - |
| ICopyDataPiece | - |
| ICopyPastePayload | - |
| IDiscreteRange | - |
| IDragCellPosition | - |
| IEditorBridgeService | - |
| IEditorBridgeServiceParam | - |
| IEditorBridgeServiceVisibleParam | - |
| IFormulaEditorManagerService | - |
| IHoverCellPosition | - |
| IMarkSelectionService | - |
| IScrollCommandParams | - |
| IScrollToCellCommandParams | - |
| ISelectionRenderService | - |
| ISetScrollRelativeCommandParams | - |
| ISheetAutoFillHook | - |
| ISheetClipboardHook | ClipboardHook could: 1. Before copy/cut/paste, decide whether to execute the command and prepare caches if necessary. 1. When copying, decide what content could be written into clipboard. 1. When pasting, get access to the clipboard content and append mutations to the paste command. |
| ISheetClipboardService | - |
| ISheetDiscreteRangeLocation | - |
| ISheetPasteParams | - |
| ISheetSkeletonManagerParam | - |
Type Aliases
| Type alias | Description |
|---|---|
| ICellDataWithSpanInfo | - |
| ICopyDataInTypeIndexInfo | - |
| IRangeProtectionRenderCellData | - |
Variables
| Variable | Description |
|---|---|
| ApplyFormatPainterCommand | - |
| AutoFillCommand | - |
| ExpandSelectionCommand | - |
| MoveSelectionCommand | Move selection |
| PASTE_SPECIAL_MENU_ID | - |
| PREDEFINED_HOOK_NAME | - |
| ResetScrollCommand | This command is reset the scroll position of the current view to 0, 0 |
| SHEET_UI_PLUGIN_NAME | Copyright 2023-present DreamNum Inc. |
| ScrollCommand | This command is used to manage the scroll position of the current view by specifying the cell index of the top left cell Usually triggered by click scrollbar or moving selection range. |
| ScrollToCellCommand | The command is used to scroll to the specific cell if the target cell is not in the viewport. |
| ScrollToRangeOperation | - |
| SetCellEditVisibleArrowOperation | When the editor is not clicked to change the cursor, the arrow keys will exit editing and move the cell. |
| SetCellEditVisibleOperation | - |
| SetRangeBoldCommand | It is used to set the bold style of selections or one cell, need to distinguish between selection state and edit state. If you are in the selective state, you need to set the style on the cell and the style on the rich text(p textRuns) at the same time, and if it is only in edit state, then you only need to set the style of the rich text(p textRuns) |
| SetRangeItalicCommand | - |
| SetRangeStrickThroughCommand | - |
| SetRangeUnderlineCommand | - |
| SetScrollOperation | - |
| SetScrollRelativeCommand | This command is used to manage the scroll by relative offset Usually triggered by wheel event. |
| SetZoomRatioOperation | - |
| SheetCopyCommand | - |
| SheetCutCommand | - |
| SheetPasteColWidthCommand | - |
| SheetPasteCommand | - |
| SheetPasteShortKeyCommand | - |
Functions
| Function | Description |
|---|---|
| IAutoFillService | - |
| ICellEditorManagerService | - |
| IEditorBridgeService | - |
| IFormulaEditorManagerService | - |
| IMarkSelectionService | - |
| ISelectionRenderService | - |
| ISheetClipboardService | - |
| MobileSheetBar | - |
| deriveStateFromActiveSheet$ | - |
| expandToContinuousRange | - |
| getAutoFillRepeatRange | - |
| getCoordByCell | - |
| getCoordByOffset | - |
| getCurrentRangeDisable$ | - |
| getEditorObject | - |
| getRepeatRange | - |
| getSheetObject | - |
| getTransformCoord | - |
| mergeSetRangeValues | - |
| rangeToDiscreteRange | - |
| useActiveWorkbook | - |
| useActiveWorksheet | - |
| useHighlightRange | - |
| virtualizeDiscreteRanges | - |
| whenFormulaEditorActivated | Requires the currently focused editor is a formula editor, and it is activated. |
| whenSheetEditorFocused | Requires the currently focused unit to be Workbook and the sheet editor is focused but not activated. |