API Reference
@univerjs
@univerjs/sheets-ui
Readme

@univerjs/sheets-ui v0.4.2Docs


@univerjs/sheets-ui

Enumerations

EnumerationDescription
APPLY_TYPE-
COPY_TYPE-
CellAlertType-
DATA_TYPE-
FormatPainterStatus-
JumpOver-
SELECTION_SHAPE_DEPTH-
SHEET_VIEW_KEY-
SheetMenuPosition-
SheetsUIPartCopyright 2023-present DreamNum Inc.
VIEWPORT_KEY@deprecated. use SHEET_VIEWPORT_KEY from engine-render instead.

Classes

ClassDescription
AutoFillController-
AutoFillService-
AutoHeightController-
AutoWidthController-
BaseSelectionRenderServiceThe basic implementation of selection rendering logics. It is designed to be reused for different purposes.
CellAlertManagerService-
CellCustomRenderControllerEvery render module should implement this interface.
CellEditorManagerService-
DragManagerService-
DragRenderControllerEvery render module should implement this interface.
EditingRenderControllerEvery render module should implement this interface.
EditorBridgeService-
FormulaEditorController-
HeaderFreezeRenderControllerEvery render module should implement this interface.
HeaderMoveRenderControllerEvery render module should implement this interface.
HeaderResizeRenderControllerEvery render module should implement this interface.
HoverManagerService-
HoverRenderControllerEvery render module should implement this interface.
MarkSelectionServiceFor condition format selection.
SelectionShapeThe main selection canvas component, includes leftControl,rightControl,topControl,bottomControl,backgroundControlTop,backgroundControlMiddleLeft,backgroundControlMiddleRight,backgroundControlBottom,fillControl
SheetCanvasPopManagerService-
SheetClipboardService-
SheetPermissionInitController-
SheetPermissionInterceptorBaseController-
SheetPrintInterceptorService-
SheetRenderControllerEvery render module should implement this interface.
SheetSelectionRenderServiceThis services controls rendering of normal selections in a render unit. The normal selections would also be used by Auto Fill and Copy features.
SheetSkeletonManagerServiceThis service manages the drawing of the sheet's viewModel (skeleton).
SheetUIController-
SheetsRenderServiceThis controller is responsible for managing units of a specific kind (UnierSheet) to be rendered on the canvas.
SheetsScrollRenderControllerThis controller handles scroll logic in sheet interaction.
StatusBarController-
UniverSheetsUIPluginPlug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Interfaces

InterfaceDescription
IAutoFillLocation-
IAutoFillRule-
IAutoFillService-
IBaseSheetBarProps-
ICanvasPopup-
ICellAlert-
ICellEditorManagerService-
ICopyDataPiece-
ICopyPastePayload-
IDiscreteRange-
IDragCellPosition-
IEditorBridgeService-
IEditorBridgeServiceParam-
IEditorBridgeServiceVisibleParam-
IFormatPainterBeforeApplyHookParams-
IFormatPainterHook-
IFormatPainterService-
IFormulaEditorManagerService-
IHoverCellPosition-
IMarkSelectionService-
IScrollCommandParams-
IScrollToCellCommandParams-
ISetScrollRelativeCommandParams-
ISheetAutoFillHook-
ISheetClipboardHookClipboardHook 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-
ISheetSelectionRenderService-
ISheetSkeletonManagerParam-
IUniverSheetsUIConfig-

Type Aliases

Type aliasDescription
ICellDataWithSpanInfo-
ICopyDataInTypeIndexInfo-
IRangeProtectionRenderCellData-

Variables

VariableDescription
AFFECT_LAYOUT_STYLES-
AddRangeProtectionCommand-
AddRangeProtectionFromContextMenuCommand-
AddRangeProtectionFromSheetBarCommand-
AddRangeProtectionFromToolbarCommand-
AddWorksheetMergeAllCommand-
AddWorksheetMergeCommand-
AddWorksheetMergeHorizontalCommand-
AddWorksheetMergeVerticalCommand-
AddWorksheetProtectionCommand-
ApplyFormatPainterCommand-
AutoClearContentCommand-
AutoFillCommand-
CancelFrozenCommand-
ChangeSheetProtectionFromSheetBarCommand-
ChangeZoomRatioCommandZoom
DeleteRangeMoveLeftConfirmCommand-
DeleteRangeMoveUpConfirmCommand-
DeleteRangeProtectionFromContextMenuCommand-
DeleteRangeSelectionCommand-
DeleteWorksheetProtectionCommand-
DeleteWorksheetProtectionFormSheetBarCommand-
ExpandSelectionCommand-
FONT_FAMILY_COMPONENT-
FONT_FAMILY_ITEM_COMPONENT-
FONT_SIZE_COMPONENT-
HideColConfirmCommand-
HideRowConfirmCommand-
InsertRangeMoveDownConfirmCommand-
InsertRangeMoveRightConfirmCommand-
MoveSelectionCommandMove selection (Mainly by keyboard arrow keys, Tab and Enter key see MoveSelectionEnterAndTabCommand)
MoveSelectionEnterAndTabCommandMove selection for enter and tab.
PASTE_SPECIAL_MENU_ID-
PREDEFINED_HOOK_NAME-
RANGE_SELECTOR_COMPONENT_KEYTODO@ggg: To avoid introducing the range-selector of the sheet-formula-ui package into sheet-ui, use a component key for now
RANGE_SELECTOR_SYMBOLSCopyright 2023-present DreamNum Inc.
RefillCommand-
RemoveColConfirmCommand-
RemoveRowConfirmCommand-
RemoveSheetConfirmCommand-
RenameSheetOperation-
ResetRangeTextColorCommand-
ResetScrollCommandThis command is reset the scroll position of the current view to 0, 0
SHEET_UI_PLUGIN_NAMECopyright 2023-present DreamNum Inc.
ScrollCommandThis 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 dragging srcollbar and click scrolltrack or moving selection range. NOT same as SetScrollRelativeCommand which usually trigger by wheelevent.
ScrollToCellCommandThe command is used to scroll to the specific cell if the target cell is not in the viewport.
ScrollToRangeOperation-
SelectAllCommandThis command expand selection to all neighbor ranges. If there are no neighbor ranges. Select the whole sheet.
SetActivateCellEditOperation-
SetCellEditVisibleArrowOperationWhen the editor is not clicked to change the cursor, the arrow keys will exit editing and move the cell.
SetCellEditVisibleOperation-
SetCellEditVisibleWithF2Operation-
SetColumnFrozenCommand-
SetFormatPainterOperation-
SetInfiniteFormatPainterCommand-
SetOnceFormatPainterCommand-
SetProtectionCommand-
SetRangeBoldCommandIt 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)
SetRangeFontFamilyCommand-
SetRangeFontSizeCommand-
SetRangeItalicCommand-
SetRangeProtectionCommand-
SetRangeProtectionFromContextMenuCommand-
SetRangeStrickThroughCommand-
SetRangeSubscriptCommand-
SetRangeSuperscriptCommand-
SetRangeTextColorCommand-
SetRangeUnderlineCommand-
SetRowFrozenCommand-
SetScrollOperation-
SetScrollRelativeCommandThis command is used to manage the scroll by relative offset Usually triggered by wheel event. NOT same as ScrollCommand, which is usually triggered by scrollbar.
SetSelectionFrozenCommand-
SetWorksheetProtectionCommand-
SetZoomRatioCommand-
SetZoomRatioOperation-
SheetCopyCommand-
SheetCutCommand-
SheetPasteBesidesBorderCommand-
SheetPasteColWidthCommand-
SheetPasteCommand-
SheetPasteFormatCommand-
SheetPasteShortKeyCommand-
SheetPasteValueCommand-
SheetPermissionOpenDialogOperation-
SheetPermissionOpenPanelOperation-
ShowMenuListCommand-
SidebarDefinedNameOperation-
ViewSheetPermissionFromContextMenuCommand-
ViewSheetPermissionFromSheetBarCommand-
menuSchema-

Functions

FunctionDescription
IAutoFillService-
ICellEditorManagerService-
IEditorBridgeService-
IFormatPainterService-
IFormulaEditorManagerService-
IMarkSelectionService-
ISheetClipboardService-
ISheetSelectionRenderService-
MobileSheetBar-
RenderSheetContent-
RenderSheetFooter-
RenderSheetHeader-
SheetBar-
attachPrimaryWithCoord-
attachRangeWithCoord-
attachSelectionWithCoord-
calculateDocSkeletonRects-
checkInHeaderRangesDetect this row/col is in selections.
deriveStateFromActiveSheet$-
getAllSelection-
getAutoFillRepeatRange-
getCellRealRange-
getCoordByCell-
getCoordByOffset-
getCurrentExclusiveRangeInterest$-
getCurrentRangeDisable$-
getCustomRangePosition-
getEditingCustomRangePosition-
getEditorObject-
getObservableWithExclusiveRange$Get the observable combine with exclusive range
getRepeatRange-
getSheetObjectGet render objects of a spreadsheet.
getTopLeftSelection-
getTransformCoord-
isRangeSelector-
mergeSetRangeValues-
rangeToDiscreteRange-
useActiveWorkbook-
useActiveWorksheet-
useHighlightRange-
useWorkbooks-
virtualizeDiscreteRanges-
whenFormulaEditorActivatedRequires the currently focused editor is a formula editor, and it is activated.
whenSheetEditorFocusedRequires the currently focused unit to be Workbook and the sheet editor is focused but not activated.

Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.