@univerjs/sheets v0.5.0-beta.1 • Docs

index

Index

Enumerations

Enumeration	Description
EditStateEnum	-
InterceptCellContentPriority	-
OperatorType	-
SelectionMoveType	-
UnitAction	-
UnitObject	-
ViewStateEnum	-

Classes

Class	Description
BorderStyleManagerService	This service is for managing settings border style status.
DefinedNameDataController	-
ExclusiveRangeService	-
MergeCellController	-
NumfmtService	-
RangeMergeUtil	-
RangeProtectionCache	-
RangeProtectionPermissionDeleteProtectionPoint	-
RangeProtectionPermissionEditPoint	-
RangeProtectionPermissionManageCollaPoint	-
RangeProtectionPermissionViewPoint	-
RangeProtectionRefRangeService	-
RangeProtectionRenderModel	-
RangeProtectionRuleModel	-
RangeProtectionService	-
RefRangeService	Collect side effects caused by ref range change
RefSelectionsService	RefSelectionsService treats `selectionMoveStart$` `selectionMoving$` and `selectionMoveEnd$` differently than `SheetsSelectionsService`. Because ref selections can be in different workbooks.
SheetInterceptorService	This class expose methods for sheet features to inject code to sheet underlying logic.
SheetsSelectionsService	-
UniverSheetsPlugin	Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.
WorkbookCommentPermission	-
WorkbookCopyPermission	-
WorkbookCopySheetPermission	-
WorkbookCreateProtectPermission	-
WorkbookCreateSheetPermission	-
WorkbookDeleteSheetPermission	-
WorkbookDuplicatePermission	-
WorkbookEditablePermission	-
WorkbookExportPermission	-
WorkbookHideSheetPermission	-
WorkbookHistoryPermission	-
WorkbookManageCollaboratorPermission	-
WorkbookMoveSheetPermission	-
WorkbookPermissionService	-
WorkbookPrintPermission	-
WorkbookRecoverHistoryPermission	-
WorkbookRenameSheetPermission	-
WorkbookSelectionModel	Origin name: WorkbookSelections NOT Same as @univerjs/sheets-ui.SelectionRenderModel, that’s data for SelectionControl in rendering.
WorkbookSharePermission	-
WorkbookViewHistoryPermission	-
WorkbookViewPermission	-
WorksheetCopyPermission	-
WorksheetDeleteColumnPermission	-
WorksheetDeleteProtectionPermission	-
WorksheetDeleteRowPermission	-
WorksheetEditExtraObjectPermission	-
WorksheetEditPermission	-
WorksheetFilterPermission	-
WorksheetInsertColumnPermission	-
WorksheetInsertHyperlinkPermission	-
WorksheetInsertRowPermission	-
WorksheetManageCollaboratorPermission	-
WorksheetPermissionService	-
WorksheetPivotTablePermission	-
WorksheetProtectionPointModel	-
WorksheetProtectionRuleModel	-
WorksheetSelectProtectedCellsPermission	-
WorksheetSelectUnProtectedCellsPermission	-
WorksheetSetCellStylePermission	-
WorksheetSetCellValuePermission	-
WorksheetSetColumnStylePermission	-
WorksheetSetRowStylePermission	-
WorksheetSortPermission	-
WorksheetViewPermission	-

Interfaces

Interface	Description
IAddRangeProtectionCommandParams	-
IAddRangeProtectionMutationParams	-
IAddWorksheetMergeMutationParams	Params of AddWorksheetMergeMutation
IAddWorksheetProtectionParams	-
IBorderInfo	-
ICancelFrozenCommandParams	-
ICopySheetCommandParams	-
IDeleteRangeMoveLeftCommandParams	-
IDeleteRangeMoveUpCommandParams	-
IDeleteRangeMutationParams	Params of DeleteRange
IDeleteRangeProtectionCommandParams	-
IDeleteRangeProtectionMutationParams	-
IDeleteWorksheetProtectionParams	-
IDeltaColumnWidthCommandParams	-
IDeltaRowHeightCommand	-
IExclusiveRangeService	-
IInsertColCommandParams	-
IInsertColMutationParams	Params of InsertColMutation
IInsertRangeMutationParams	Params of InsertRange
IInsertRowCommandParams	-
IInsertRowMutationParams	Params of InsertRowMutation
IInsertSheetCommandParams	-
IInsertSheetMutationParams	Params of `InsertSheetMutation`
IMoveColsCommandParams	-
IMoveColumnsMutationParams	-
IMoveRangeCommandParams	-
IMoveRangeMutationParams	-
IMoveRowsCommandParams	-
IMoveRowsMutationParams	-
InsertRangeMoveDownCommandParams	-
InsertRangeMoveRightCommandParams	-
INumfmtItemWithCache	-
INumfmtService	-
IRangeProtectionRule	-
IRemoveColMutationParams	Params of InsertColMutation
IRemoveNumfmtMutationParams	-
IRemoveRowColCommandInterceptParams	-
IRemoveRowColCommandParams	-
IRemoveRowsMutationParams	Params of InsertRowMutation
IRemoveSheetCommandParams	-
IRemoveSheetMutationParams	Params of `RemoveSheetMutation`
IRemoveWorksheetMergeMutationParams	Params of RemoveWorksheetMergeMutation
IReorderRangeCommandParams	Copyright 2023-present DreamNum Inc.
IReorderRangeMutationParams	Copyright 2023-present DreamNum Inc.
ISelectionStyle	https://support.microsoft.com/en-us/office/select-cell-contents-in-excel-23f64223-2b6b-453a-8688-248355f10fa9
ISelectionWidgetConfig	Whether to display the controller that modifies the selection, distributed in 8 locations tl top_left_corner tc top_center_corner tr top_right_corner ml middle_left_corner mr middle_right_corner bl bottom_left_corner bc bottom_center_corner br bottom_right_corner
ISelectionWithCoord	Selection range Info, contains selection range & primary range primary range is the range of the highlighted cell.
ISelectionWithStyle	range: IRange; primary: Nullable; style: Nullable;
ISetBorderBasicCommandParams	-
ISetBorderColorCommandParams	-
ISetBorderCommandParams	-
ISetBorderPositionCommandParams	-
ISetBorderStyleCommandParams	-
ISetColDataCommandParams	-
ISetColDataMutationParams	-
ISetColHiddenMutationParams	-
ISetColorCommandParams	-
ISetColVisibleMutationParams	-
ISetFontFamilyCommandParams	-
ISetFontSizeCommandParams	-
ISetFrozenCommandParams	-
ISetFrozenMutationParams	-
ISetHorizontalTextAlignCommandParams	-
ISetNumfmtMutationParams	-
ISetRangeProtectionMutationParams	-
ISetRangeValuesCommandParams	-
ISetRangeValuesMutationParams	Params of `SetRangeValuesMutation`
ISetRangeValuesRangeMutationParams	Params of `SetRangeValuesMutation`
ISetRowDataCommandParams	-
ISetRowDataMutationParams	-
ISetRowHiddenMutationParams	-
ISetRowVisibleMutationParams	-
ISetSelectionsOperationParams	-
ISetSpecificColsVisibleCommandParams	-
ISetSpecificRowsVisibleCommandParams	-
ISetStyleCommandParams	-
ISetTabColorMutationParams	-
ISetTextRotationCommandParams	-
ISetTextWrapCommandParams	-
ISetVerticalTextAlignCommandParams	-
ISetWorkbookNameCommandParams	-
ISetWorkbookNameMutationParams	-
ISetWorksheetActivateCommandParams	-
ISetWorksheetActiveOperationParams	-
ISetWorksheetColWidthMutationParams	-
ISetWorksheetDefaultStyleMutationParams	-
ISetWorksheetHideMutationParams	-
ISetWorksheetNameCommandParams	-
ISetWorksheetNameMutationParams	-
ISetWorksheetOrderMutationParams	-
ISetWorksheetPermissionPointsMutationParams	-
ISetWorksheetProtectionParams	-
ISetWorksheetRowAutoHeightMutationParams	-
ISetWorksheetRowHeightMutationParams	-
ISetWorksheetRowIsAutoHeightCommandParams	-
ISetWorksheetRowIsAutoHeightMutationParams	-
ISetWorksheetShowCommandParams	-
ISheetCommandSharedParams	Copyright 2023-present DreamNum Inc.
ISheetLocation	-
ISheetLocationBase	-
ISheetRangeLocation	-
ISheetRowLocation	-
IStyleTypeValue	-
IToggleCellCheckboxCommandParams	-
IToggleGridlinesCommandParams	-
IToggleGridlinesMutationParams	-
IUniverSheetsConfig	-
IWorksheetProtectionRule	-

Type Aliases

Type alias	Description
EffectRefRangeParams	-
FormatType	-
ICellPermission	-
IModel	-
INumfmtItem	-
IObjectModel	-
IOperator	-
IRangePermissionPoint	-
ISetCellsNumfmt	-
IWorksheetProtectionRenderCellData	-

Variables

Variable	Description
AddRangeProtectionCommand	-
AddRangeProtectionMutation	-
AddWorksheetMergeAllCommand	-
AddWorksheetMergeCommand	-
AddWorksheetMergeHorizontalCommand	-
AddWorksheetMergeMutation	-
AddWorksheetMergeVerticalCommand	-
AddWorksheetProtectionCommand	-
AddWorksheetProtectionMutation	-
AFTER_CELL_EDIT	-
AFTER_CELL_EDIT_ASYNC	-
baseProtectionActions	-
BEFORE_CELL_EDIT	-
CancelFrozenCommand	-
ClearSelectionAllCommand	The command to clear all in current selected ranges.
ClearSelectionContentCommand	The command to clear content in current selected ranges.
ClearSelectionFormatCommand	The command to clear content in current selected ranges.
COMMAND_LISTENER_SKELETON_CHANGE	Mutations those will trigger the skeleton change.
COMMAND_LISTENER_VALUE_CHANGE	-
CopySheetCommand	-
defaultWorkbookPermissionPoints	-
defaultWorksheetPermissionPoint	-
DeleteRangeMoveLeftCommand	The command to delete range.
DeleteRangeMoveUpCommand	The command to delete range.
DeleteRangeProtectionCommand	-
DeleteRangeProtectionMutation	-
DeleteWorksheetProtectionCommand	-
DeleteWorksheetProtectionMutation	-
DeltaColumnWidthCommand	-
DeltaRowHeightCommand	-
DISABLE_NORMAL_SELECTIONS	An context key to disable normal selections if its value is set to `true`.
EffectRefRangId	-
EmptyMutation	-
InsertColAfterCommand	-
InsertColBeforeCommand	-
InsertColCommand	-
InsertColMutation	-
InsertDefinedNameCommand	The command to insert new defined name
InsertRangeMoveDownCommand	The command to insert range.
InsertRangeMoveRightCommand	The command to insert range.
InsertRowAfterCommand	-
InsertRowBeforeCommand	-
InsertRowCommand	this command and its interface should not be exported from index.ts
InsertRowMutation	-
InsertSheetCommand	The command to insert new worksheet
InsertSheetMutation	-
INTERCEPTOR_POINT	-
MAX_CELL_PER_SHEET_KEY	Copyright 2023-present DreamNum Inc.
MERGE_CELL_INTERCEPTOR_CHECK	-
MoveColsCommand	-
MoveColsMutation	-
MoveRangeCommand	-
MoveRangeMutation	-
MoveRowsCommand	Command to move the selected rows (must currently selected) to the specified row.
MoveRowsMutation	-
RemoveColCommand	This command would remove the selected columns. These selected rows can be non-continuous.
RemoveColMutation	-
RemoveDefinedNameCommand	The command to remove new defined name
RemoveNumfmtMutation	-
RemoveRowCommand	This command would remove the selected rows. These selected rows can be non-continuous.
RemoveRowMutation	-
RemoveSheetCommand	The command to insert new worksheet
RemoveSheetMutation	-
RemoveWorksheetMergeCommand	-
RemoveWorksheetMergeMutation	-
ReorderRangeCommand	-
ReorderRangeMutation	-
ResetBackgroundColorCommand	-
ResetTextColorCommand	-
ScrollToCellOperation	-
SELECTION_CONTROL_BORDER_BUFFER_COLOR	-
SELECTION_CONTROL_BORDER_BUFFER_WIDTH	-
SetBackgroundColorCommand	-
SetBoldCommand	Set bold font style to currently selected ranges. If the cell is already bold then it will cancel the bold style.
SetBorderBasicCommand	-
SetBorderColorCommand	-
SetBorderCommand	Set border info for range, including clear border (type = NONE)
SetBorderPositionCommand	-
SetBorderStyleCommand	-
SetColDataCommand	-
SetColDataMutation	-
SetColHiddenCommand	-
SetColHiddenMutation	-
SetColVisibleMutation	-
SetColWidthCommand	-
SetDefinedNameCommand	The command to update defined name
SetFontFamilyCommand	-
SetFontSizeCommand	-
SetFrozenCommand	-
SetFrozenMutation	-
SetHorizontalTextAlignCommand	-
SetItalicCommand	Set italic font style to currently selected ranges. If the cell is already italic then it will cancel the italic style.
SetNumfmtMutation	-
SetOverlineCommand	Set overline font style to currently selected ranges. If the cell is already overline then it will cancel the overline style.
SetProtectionCommand	-
SetRangeProtectionMutation	-
SetRangeValuesCommand	The command to set values for ranges.
SetRangeValuesMutation	-
SetRowDataCommand	-
SetRowDataMutation	-
SetRowHeightCommand	-
SetRowHiddenCommand	-
SetRowHiddenMutation	-
SetRowVisibleMutation	-
SetSelectedColsVisibleCommand	-
SetSelectedRowsVisibleCommand	-
SetSelectionsOperation	Set selections to SelectionModel(WorkbookSelectionModel) by selectionManagerService.
SetSpecificColsVisibleCommand	-
SetSpecificRowsVisibleCommand	-
SetStrikeThroughCommand	Set strike through font style to currently selected ranges. If the cell is already stroke then it will cancel the stroke style.
SetStyleCommand	The command to set cell style. Set style to a bunch of ranges.
SetTabColorCommand	-
SetTabColorMutation	-
SetTextColorCommand	-
SetTextRotationCommand	-
SetTextWrapCommand	-
SetUnderlineCommand	Set underline font style to currently selected ranges. If the cell is already underline then it will cancel the underline style.
SetVerticalTextAlignCommand	-
SetWorkbookNameCommand	The command to set the workbook name. It does not support undo redo.
SetWorkbookNameMutation	-
SetWorksheetActivateCommand	-
SetWorksheetActiveOperation	-
SetWorksheetColWidthMutation	Set width of column manually
SetWorksheetDefaultStyleCommand	-
SetWorksheetDefaultStyleMutation	-
SetWorksheetHideCommand	-
SetWorksheetHideMutation	-
SetWorksheetNameCommand	The command to set the sheet name.
SetWorksheetNameMutation	-
SetWorksheetOrderCommand	-
SetWorksheetOrderMutation	-
SetWorksheetPermissionPointsCommand	-
SetWorksheetPermissionPointsMutation	-
SetWorksheetProtectionCommand	-
SetWorksheetProtectionMutation	-
SetWorksheetRightToLeftCommand	-
SetWorksheetRightToLeftMutation	-
SetWorksheetRowAutoHeightMutation	-
SetWorksheetRowHeightMutation	-
SetWorksheetRowIsAutoHeightCommand	-
SetWorksheetRowIsAutoHeightMutation	-
SetWorksheetShowCommand	-
ToggleCellCheckboxCommand	-
ToggleGridlinesCommand	-
ToggleGridlinesMutation	-

Functions

Function	Description
addMergeCellsUtil	-
AddMergeRedoSelectionsOperationFactory	-
AddMergeUndoMutationFactory	-
AddMergeUndoSelectionsOperationFactory	-
alignToMergedCellsBorders	Adjust the range to align merged cell’s borders.
checkRangesEditablePermission	-
convertPrimaryWithCoordToPrimary	-
convertSelectionDataToRange	Process a selection with coordinates and style, and extract the coordinate information, because the render needs coordinates when drawing. Since the selection.manager.service is unrelated to the coordinates, it only accepts data of type ISelectionWithStyle, so a conversion is necessary.
copyRangeStyles	Copy the styles of a range of cells to another range. Used for insert row and insert column.
createTopMatrixFromMatrix	-
createTopMatrixFromRanges	-
expandToContinuousRange	Expand the range to a continuous range, it uses when Ctrl + A , or only one cell selected to add a pivot table adn so on.
FactoryAddRangeProtectionMutation	-
FactoryDeleteRangeProtectionMutation	-
factoryRemoveNumfmtUndoMutation	-
factorySetNumfmtUndoMutation	-
FactorySetRangeProtectionMutation	-
findAllRectangle	-
followSelectionOperation	-
generateNullCell	Generate cellValue from range and set null
generateNullCellValue	Generate cellValue from range and set v/p/f/si/custom to null
getAddMergeMutationRangeByType	calculates the selection based on the merged cell type
getAllRangePermissionPoint	-
getAllWorkbookPermissionPoint	-
getAllWorksheetPermissionPoint	-
getAllWorksheetPermissionPointByPointPanel	-
getCellAtRowCol	-
getDefaultRangePermission	-
getInsertRangeMutations	InsertRange is not a mutation but combination of `SetRangeValuesMutation` and `MoveRangeMutation`.
getMoveRangeUndoRedoMutations	-
getPrimaryForRange	Get the default primary cell (the most top-left cell) of a range.
getRemoveRangeMutations	-
getSelectionsService	-
getSeparateEffectedRangesOnCommand	-
getSheetCommandTarget	Get targeted Workbook & Worksheet of a command. If `unitId` and `subUnitId` are given, the function would try to get these instances. If not, it would try to get the current active instances.
getSheetCommandTargetWorkbook	-
getSheetMutationTarget	-
handleBaseInsertRange	-
handleBaseMoveRowsCols	see docs/tldr/ref-range/move-rows-cols.tldr
handleBaseRemoveRange	-
handleCommonDefaultRangeChangeWithEffectRefCommands	-
handleCommonRangeChangeWithEffectRefCommandsSkipNoInterests	-
handleDefaultRangeChangeWithEffectRefCommands	-
handleDefaultRangeChangeWithEffectRefCommandsSkipNoInterests	-
handleDeleteRangeMoveLeft	-
handleDeleteRangeMoveUp	-
handleDeleteRangeMutation	-
handleInsertCol	-
handleInsertRangeMoveDown	-
handleInsertRangeMoveRight	-
handleInsertRangeMutation	-
handleInsertRow	-
handleIRemoveCol	-
handleIRemoveRow	-
handleMoveCols	-
handleMoveRange	-
handleMoveRows	-
IExclusiveRangeService	-
InsertColMutationUndoFactory	-
InsertRowMutationUndoFactory	-
InsertSheetUndoMutationFactory	Generate undo mutation of a `InsertSheetMutation`
INumfmtService	-
IRefSelectionsService	Ref selections service reuses code of `SelectionManagerService`. And it only contains ref selections when user is editing formula.
isSingleCellSelection	Examine if a selection only contains a single cell (a merged cell is considered as a single cell in this case).
MoveColsMutationUndoFactory	-
MoveRowsMutationUndoFactory	Get an undo mutation for the move rows mutation.
rangeMerge	Some operations generate sparse ranges such as paste/autofill/ref-range, and this function merge some small ranges into some large ranges to reduce transmission size. Time Complexity: O(mn) , where m and n are rows and columns. It takes O(mn) to compute the markMatrix and O(n) to apply the histogram algorithm to each column. ps. column sparse matrices have better performance
RemoveMergeUndoMutationFactory	-
RemoveSheetUndoMutationFactory	Generate undo mutation of a `RemoveSheetMutation`
ReorderRangeUndoMutationFactory	-
rotateRange	-
runRefRangeMutations	-
SetColDataMutationFactory	-
setEndForRange	-
SetFrozenMutationFactory	-
SetRangeValuesUndoMutationFactory	Generate undo mutation of a `SetRangeValuesMutation`
SetRowDataMutationFactory	-
SetWorksheetColWidthMutationFactory	This factory is for generating undo mutations for command DeltaColumnWidthCommand.
SetWorksheetDefaultStyleMutationFactory	-
SetWorksheetRowAutoHeightMutationFactory	-
transformCellsToRange	-

Fontweight Borderstylemanagerservice