@univerjs/docs v0.1.17 • Docs

@univerjs/docs

Enumerations

Enumeration	Description
DOCS_VIEW_KEY	Copyright 2023-present DreamNum Inc.
VIEWPORT_KEY	-

Classes

Class	Description
DocSkeletonManagerService	This service is for document build and manage doc skeletons. It also manages DocumentViewModels.
DocStateChangeManagerService	-
IMEInputManagerService	-
TextSelectionManagerService	This service is for text selection.
UniverDocsPlugin	Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Interfaces

Interface	Description
ICoverCommandParams	-
IDeleteCommandParams	-
IDocObjectParam	-
IDocStateChangeParams	-
IIMEInputCommandParams	-
IInsertCommandParams	-
IRichTextEditingMutationParams	-
ISetDocZoomRatioOperationParams	-
ISetTextSelectionsOperationParams	-
IUniverDocsConfig	-
IUpdateCommandParams	-

Variables

Variable	Description
AlignCenterCommand	-
AlignJustifyCommand	-
AlignLeftCommand	-
AlignOperationCommand	-
AlignRightCommand	-
BreakLineCommand	-
BulletListCommand	-
CoverContentCommand	-
CutContentCommand	-
DOCS_COMPONENT_BACKGROUND_LAYER_INDEX	-
DOCS_COMPONENT_DEFAULT_Z_INDEX	-
DOCS_COMPONENT_HEADER_LAYER_INDEX	-
DOCS_COMPONENT_MAIN_LAYER_INDEX	-
DeleteCommand	The command to delete text, mainly used in BACKSPACE and DELETE when collapsed is true. ONLY handle collapsed range!!!
DeleteLeftCommand	-
DeleteRightCommand	-
EditorInsertTextCommandId	-
IMEInputCommand	-
InnerPasteCommand	-
InsertCommand	The command to insert text. The changed range could be non-collapsed, mainly use in line break and normal input.
MoveCursorOperation	The operation to move cursor in the current document.
MoveSelectionOperation	The operation to move selection in the current document.
NORMAL_TEXT_SELECTION_PLUGIN_NAME	-
OrderListCommand	-
ReplaceContentCommand	-
ResetInlineFormatTextBackgroundColorCommand	-
RichTextEditingMutation	The core mutator to change rich text actions. The execution result would be undo mutation params. Could be directly send to undo redo service (will be used by the triggering command).
SelectAllOperation	-
SetDocZoomRatioCommand	-
SetDocZoomRatioOperation	-
SetInlineFormatBoldCommand	-
SetInlineFormatCommand	-
SetInlineFormatFontFamilyCommand	-
SetInlineFormatFontSizeCommand	-
SetInlineFormatItalicCommand	-
SetInlineFormatStrikethroughCommand	-
SetInlineFormatSubscriptCommand	-
SetInlineFormatSuperscriptCommand	-
SetInlineFormatTextBackgroundColorCommand	-
SetInlineFormatTextColorCommand	-
SetInlineFormatUnderlineCommand	-
SetTextSelectionsOperation	-
UpdateCommand	The command to update text properties, mainly used in BACKSPACE.

Functions

Function	Description
getDocObject	-
getDocObjectById	-
neoGetDocObject	-
serializeTextRange	-

Updatedatavalidationsettingcommand Docskeletonmanagerservice