@univerjs/core v0.1.17 • Docs
@univerjs/core
Namespaces
| Namespace | Description |
|---|---|
| JSON1 | - |
Enumerations
| Enumeration | Description |
|---|---|
| AbsoluteRefType | none: A1 row: A$1 column: $A1 all: $A$1 |
| AlignTypeH | - |
| AlignTypeV | - |
| ArrangeTypeEnum | - |
| ArrowsAndMarkersShapes | - |
| AutoFillSeries | Copyright 2023-present DreamNum Inc. |
| BaselineOffset | - |
| BasicShapes | Copyright 2023-present DreamNum Inc. |
| BlockType | Type of block |
| BooleanNumber | General Boolean Enum |
| BorderStyleTypes | Copyright 2023-present DreamNum Inc. |
| BorderType | - |
| BulletAlignment | The types of alignment for a bullet. |
| CellValueType | General Boolean Enum |
| ColorType | Copyright 2023-present DreamNum Inc. |
| ColumnSeparatorType | The style of column separators between columns. |
| CommandType | - |
| CommonHideTypes | Copyright 2023-present DreamNum Inc. |
| ContentAlignment | The content alignments for a Shape or TableCell. The supported alignments correspond to predefined text anchoring types from the ECMA-376 standard. |
| CopyPasteType | Copyright 2023-present DreamNum Inc. |
| CustomRangeType | - |
| DashStyleType | The kinds of dashes with which linear geometry can be rendered. |
| DataStreamTreeNodeType | Copyright 2023-present DreamNum Inc. |
| DataStreamTreeTokenType | - |
| DataValidationErrorStyle | Copyright 2023-present DreamNum Inc. |
| DataValidationImeMode | Copyright 2023-present DreamNum Inc. |
| DataValidationOperator | Copyright 2023-present DreamNum Inc. |
| DataValidationRenderMode | Copyright 2023-present DreamNum Inc. |
| DataValidationStatus | Copyright 2023-present DreamNum Inc. |
| DataValidationType | Copyright 2023-present DreamNum Inc. |
| DeveloperMetadataVisibility | Copyright 2023-present DreamNum Inc. |
| Dimension | Copyright 2023-present DreamNum Inc. |
| Direction | Copyright 2023-present DreamNum Inc. |
| DocStyleType | - |
| DrawingTypeEnum | - |
| EXTENSION_NAMES | Copyright 2023-present DreamNum Inc. |
| FollowNumberWithType | Follow the space after the list |
| FontItalic | FontItalic |
| FontStyleType | Types of font style |
| FontWeight | FontWeight |
| FormatType | Copyright 2023-present DreamNum Inc. |
| GlyphType | An enumeration of the supported glyph types. |
| GridType | - |
| HorizontalAlign | An enum that specifies the horizontal alignment of text. |
| InterpolationPointType | Copyright 2023-present DreamNum Inc. |
| LifecycleStages | This enum defines multiple lifecycle stages in Univer SDK. |
| LocaleType | Copyright 2023-present DreamNum Inc. |
| LogLevel | - |
| NamedStyleType | Types of name style |
| NumberUnitType | - |
| ObjectRelativeFromH | - |
| ObjectRelativeFromV | - |
| OtherShapes | - |
| PageElementType | - |
| PageOrientType | Paper orientation, whether it's portrait (vertical) or landscape (horizontal) |
| PageType | - |
| ParagraphElementType | - |
| PermissionStatus | - |
| PositionedObjectLayoutType | The possible layouts of a [PositionedObject] |
| PresetListType | - |
| ProtectionType | Copyright 2023-present DreamNum Inc. |
| RANGE_TYPE | Copyright 2023-present DreamNum Inc. |
| RelativeDate | Copyright 2023-present DreamNum Inc. |
| RelativeSlideLink | - |
| SectionType | Represents how the start of the current section is positioned relative to the previous section. |
| SheetTypes | Copyright 2023-present DreamNum Inc. |
| SpacingRule | - |
| SpecialShapes | - |
| TabStopAlignment | The alignment of the tab stop. |
| TextDecoration | Types of text decoration |
| TextDirection | Copyright 2023-present DreamNum Inc. |
| TextDirectionType | Direction of text |
| TextXActionType | - |
| ThemeColorType | Copyright 2023-present DreamNum Inc. |
| ThemeColors | - |
| UniverInstanceType | - |
| UpdateDocsAttributeType | Copyright 2023-present DreamNum Inc. |
| VerticalAlign | An enum that specifies the vertical alignment of text. |
| WidthType | Type of width |
| WrapStrategy | An enumeration of the strategies used to handle cell text wrapping. |
| WrapTextType | Types of wrap text |
| characterSpacingControlType | - |
Classes
| Class | Description |
|---|---|
| ActionIterator | - |
| AuthzIoLocalService | Do not use the mock implementation in a production environment as it is a minimal version. |
| ClientSnapshotServerService | The server needs to fully implement all interfaces, but when used by the client, use saveSheetBlock to cache the sheet block locally, and use getSheetBlock to obtain the sheet block. |
| Color | - |
| ColorBuilder | - |
| ColorKit | - |
| CommandService | - |
| ConfigService | - |
| ContextService | - |
| DesktopLogService | - |
| Disposable | - |
| DisposableCollection | - |
| DocumentDataModel | - |
| Entry | - |
| EntryIterator | - |
| ErrorService | - |
| EventState | A class serves as a medium between the observable and its observers |
| EventSubject | This is a custom implementation of RxJS subject. It handles events on canvas elements. In addition to the event, it also emits a state object that can be used to controls the propagation of the event. |
| HLSColor | - |
| InterceptorManager | - |
| JSONX | - |
| KeyIterator | - |
| LRUHelper | Copyright 2023-present DreamNum Inc. |
| LRUMap | - |
| LifecycleInitializerService | This service is used to initialize modules on a certain lifecycle stage. Refer to runOnLifecycle and OnLifecycle for more details. |
| LifecycleService | This service controls the lifecycle of a Univer instance. Other modules can inject this service to read the current lifecycle stage or subscribe to lifecycle changes. |
| LocalUndoRedoService | This UndoRedoService is local. |
| LocaleService | This service provides i18n and timezone / location features to other modules. |
| MemoryCursor | Copyright 2023-present DreamNum Inc. |
| ObjectMatrix | A two-dimensional array represented by a two-level deep object and provides an array-like API |
| PermissionService | - |
| Plugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
| PluginService | This service manages plugin registration. |
| Range | Access and modify spreadsheet ranges. |
| Rectangle | This class provides a set of methods to calculate IRange. |
| RefAlias | Copyright 2023-present DreamNum Inc. |
| Registry | Copyright 2023-present DreamNum Inc. |
| RegistryAsMap | Add extension modules statically when the plugin is initialized, so that the plugin can register these extension modules uniformly |
| ResourceManagerService | - |
| RgbColor | - |
| RxDisposable | - |
| SheetViewModel | - |
| SlideDataModel | - |
| Styles | Styles in a workbook, cells locate styles based on style IDs |
| TextX | - |
| ThemeColor | - |
| ThemeService | - |
| Tools | Universal tool library |
| UnitModel | - |
| Univer | - |
| UniverInstanceService | IUniverInstanceService holds all the current univer instances and provides a set of methods to add and remove univer instances. |
| UserManagerService | - |
| ValueIterator | - |
| Workbook | Access and create Univer Sheets files |
| Worksheet | The model of a Worksheet. |
Interfaces
| Interface | Description |
|---|---|
| Class | Class type |
| IAbsoluteTransform | Copyright 2023-present DreamNum Inc. |
| IAuthzIoService | - |
| IBorderData | Style properties of top, bottom, left and right border |
| IBorderStyleData | Style properties of border |
| IBullet | Properties of list |
| ICellCustomRender | - |
| ICellData | Cell data |
| ICellDataForSheetInterceptor | Cell data |
| ICellMarks | - |
| ICellMarksStyle | - |
| ICellRenderContext | - |
| IChartProperties | ChartProperties |
| IColor | Format of RBGA color |
| IColorStyle | RGB color or theme color |
| IColumnData | Properties of column data |
| ICommand | - |
| ICommandInfo | The command info, only a command id and responsible params |
| ICommandService | - |
| IConfigService | - |
| IContextService | - |
| ICopyToOptionsData | Option of copyTo function |
| ICropProperties | Properties of crop image |
| ICustomBlock | Custom Block |
| ICustomRange | - |
| IDataValidationRule | - |
| IDataValidationRuleBase | - |
| IDataValidationRuleInfo | - |
| IDataValidationRuleOptions | - |
| IDeleteAction | Delete mutation is used to delete text at the given position. |
| IDocDrawingBase | Properties of Drawing 20.4.2.8 inline (Inline DrawingML Object) 20.4.2.15 wrapNone (No Text Wrapping) 20.4.2.16 wrapPolygon (Wrapping Polygon) 20.4.2.17 wrapSquare (Square Wrapping) 20.4.2.18 wrapThrough (Through Wrapping) 20.4.2.19 wrapTight (Tight Wrapping) 20.4.2.20 wrapTopAndBottom (Top and Bottom Wrapping) |
| IDocDrawingPosition | Properties of a draw object |
| IDocStyle | - |
| IDocStyleBase | Basics properties of doc style |
| IDocStyles | Set of IStyles |
| IDocsBorder | Properties of doc border |
| IDocumentBody | Properties of document body Contain three update types: range overlay, range mutual exclusion, and placeholder \v COLUMN_BREAK \f PAGE_BREAK \0 DOCS_END \t TAB |
| IDocumentData | Properties of document |
| IDocumentLayout | - |
| IDocumentRenderConfig | the alignment mode is returned with respect to the offset of the sheet cell, because the document needs to render the layout for cells and support alignment across multiple cells (e.g., horizontal alignment of long text in overflow mode). The alignment mode of the document itself cannot meet this requirement, so an additional renderConfig needs to be added during the rendering of the document component. This means that there are two coexisting alignment modes. In certain cases, such as in an editor, conflicts may arise, requiring only one alignment mode to be retained. By removing the relevant configurations in renderConfig, the alignment mode of the sheet cell can be modified. The alternative alignment mode is applied to paragraphs within the document. |
| IDocumentSettings | - |
| IDocumentStyle | Basics properties of doc style |
| IDrawingParam | - |
| IDrawingSearch | - |
| IDrawingSpace | - |
| IDrawings | Set of Drawings |
| IError | - |
| IEventObserver | - |
| IExecutionOptions | - |
| IFooterData | Properties of doc footer |
| IFooters | Set of footer |
| IFreeze | Copyright 2023-present DreamNum Inc. |
| IGridRange | Range data of grid |
| IHeaderAndFooterBase | - |
| IHeaderData | Properties of doc header |
| IHeaders | Set of headers |
| IHyperlink | - |
| IImage | - |
| IImageProperties | Copyright 2023-present DreamNum Inc. |
| IIndentStart | - |
| IInsertAction | Insert mutation is used to insert text (maybe with rich text properties) at the given position. |
| IInterceptor | - |
| IKeyType | Custom type of key |
| IKeyValue | Key value object |
| ILanguagePack | - |
| IListData | The properties of a list which describe the look and feel of bullets belonging to paragraphs associated with a list. |
| ILists | Set of lists |
| ILocalStorageService | - |
| ILocales | - |
| ILogContext | Copyright 2023-present DreamNum Inc. |
| ILogService | - |
| IMargin | - |
| IMultiCommand | - |
| IMutation | Mutation would change the model of Univer applications. |
| IMutationCommonParams | - |
| IMutationInfo | - |
| INestingLevel | Contains properties describing the look and feel of a list bullet at a given level of nesting. |
| INumberUnit | - |
| IObjectArrayPrimitiveType | - |
| IObjectMatrixPrimitiveType | Object Matrix Primitive Type |
| IObjectPositionH | - |
| IObjectPositionV | - |
| IOffset | - |
| IOperation | Operation would change the state of Univer applications. State should only be in memory and does not require conflicting resolution. |
| IOperationInfo | - |
| IOptionData | Whether to clear only the contents. Whether to clear only the format; note that clearing format also clears data validation rules. |
| IOutline | - |
| IPaddingData | Top,right,bottom,left padding |
| IPageElement | - |
| IParagraph | - |
| IParagraphBorder | Properties of paragraph border |
| IParagraphStyle | Properties of paragraph style |
| IPermissionParam | - |
| IPermissionPoint | - |
| IPermissionService | - |
| IPermissionTypes | - |
| IPlaceholder | - |
| IPosition | Properties of selection data |
| IRange | Range data structure |
| IRangeArrayData | One of the range types, |
| IRangeCellData | The row and column numbers represent a cell |
| IRangeWithCoord | Properties of selection data |
| IRectLTRB | - |
| IReferenceSource | - |
| IResourceHook | - |
| IResourceLoaderService | - |
| IResourceManagerService | - |
| IRetainAction | Retain mutation is used to move the cursor or to update properties of the text in the given range. |
| IRgbColor | Copyright 2023-present DreamNum Inc. |
| IRichTextProps | - |
| IRotationSkewFlipTransform | - |
| IRowAutoHeightInfo | - |
| IRowColIter | Copyright 2023-present DreamNum Inc. |
| IRowData | Properties of row data |
| IRowRange | - |
| IScale | - |
| ISectionBreak | Properties of section break |
| ISectionBreakBase | - |
| ISectionColumnProperties | Properties of section column |
| ISelection | - |
| ISelectionCell | Range data structure |
| ISelectionCellWithCoord | Properties of selection data |
| ISelectionWithCoord | - |
| ISequenceExecuteResult | Copyright 2023-present DreamNum Inc. |
| IServiceData | Copyright 2023-present DreamNum Inc. |
| IShading | Properties of shading |
| IShape | IShape |
| IShapeProperties | ShapeProperties |
| ISheetDataValidationRule | - |
| ISingleCell | - |
| ISize | Copyright 2023-present DreamNum Inc. |
| ISlideData | - |
| ISlidePage | - |
| ISnapshotServerService | - |
| ISrcRect | - |
| IStyleBase | Basics properties of cell style |
| IStyleData | Properties of cell style |
| IStyleSheet | - |
| ITabStop | A tab stop within a paragraph. |
| ITable | Properties of table |
| ITableCell | Properties of table cell |
| ITableCellBorder | Properties of cell border |
| ITableCellStyle | Properties of style of table cell |
| ITableOfContent | - |
| ITableRow | Properties of row of table |
| ITableRowStyle | Properties of style table row |
| ITextDecoration | Properties of text decoration |
| ITextRange | - |
| ITextRangeParam | - |
| ITextRangeStart | - |
| ITextRotation | - |
| ITextRun | A ParagraphElement that represents a run of text that all has the same styling. |
| ITextStyle | Properties of text style |
| ITransformState | - |
| IUndoRedoCommandInfos | - |
| IUndoRedoCommandInfosByInterceptor | - |
| IUndoRedoItem | - |
| IUndoRedoService | - |
| IUndoRedoStatus | - |
| IUnitRange | Range data of Unit |
| IUnitRangeName | - |
| IUnitRangeWithName | Range data of Unit |
| IUniverData | - |
| IUniverInstanceService | IUniverInstanceService holds all the current univer instances and provides a set of methods to add and remove univer instances. |
| IUser | - |
| IWorkbookData | Properties of a workbook's configuration |
| IWorksheetData | Snapshot of a worksheet. |
| IWorksheetOrderData | Copyright 2023-present DreamNum Inc. |
Type Aliases
| Type alias | Description |
|---|---|
| AsyncFunction | - |
| CellValue | Cell value type |
| CommandListener | - |
| DependencyOverride | Overrides the dependencies defined in the plugin. Only dependencies that are identified by IdentifierDecorator can be overridden. If you override a dependency with null, the original dependency will be removed. |
| DrawingType | - |
| IColumnStartEndData | Column data type |
| IComposeInterceptors | - |
| IRangeStringData | One of the range types, |
| IRangeType | range types |
| IRowStartEndData | Row data type |
| InterceptorHandler | - |
| LanguageValue | Copyright 2023-present DreamNum Inc. |
| LocaleTypes | - |
| NoNeedCheckedType | wrap any |
| Nullable | Copyright 2023-present DreamNum Inc. |
| PluginCtor | - |
| PresetGeometryType | - |
| ShapeType | 20.1.9.18 prstGeom (Preset geometry) |
| TPriority | - |
| TextXAction | - |
| UnitType | - |
| WorkbookPermissionPointConstructor | - |
Variables
Functions
| Function | Description |
|---|---|
| ABCToNumber | Copyright 2023-present DreamNum Inc. |
| DependentOn | Use this decorator to declare dependencies among plugins. If a dependent plugin is not registered yet, Univer will automatically register it with no configuration. |
| IAuthzIoService | - |
| ICommandService | - |
| IConfigService | - |
| IContextService | - |
| ILocalStorageService | - |
| ILogService | - |
| IPermissionService | - |
| IResourceLoaderService | - |
| IResourceManagerService | - |
| ISnapshotServerService | - |
| IUndoRedoService | - |
| IUniverInstanceService | - |
| OnLifecycle | Register the decorated class to be automatically instantiated when Univer progresses to the certain lifecycle stage. |
| afterInitApply | - |
| b64DecodeUnicode | - |
| b64EncodeUnicode | Copyright 2023-present DreamNum Inc. |
| binarySearchArray | Copyright 2023-present DreamNum Inc. |
| cellToRange | Covert row/column to range object |
| checkForSubstrings | - |
| checkIfMove | - |
| checkParagraphHasBullet | - |
| checkParagraphHasIndent | - |
| checkParagraphHasIndentByStyle | - |
| codeToBlob | Copyright 2023-present DreamNum Inc. |
| composeBody | - |
| composeInterceptors | - |
| concatMatrixArray | - |
| convertBodyToHtml | - |
| covertTextRunToHtml | - |
| createDefaultUser | - |
| createInterceptorKey | - |
| createInternalEditorID | - |
| createRowColIter | - |
| debounce | Creates a debounced function that delays invoking the provided function until after wait milliseconds have elapsed since the last time the debounced function was invoked. |
| dedupe | Deduplicate an array. |
| deepCompare | - |
| deleteContent | - |
| extractPureTextFromCell | Get pure text in a cell. |
| fromCallback | Creates an observable from a callback function. |
| fromObservable | - |
| generateTemporarySnap | - |
| getArrayLength | - |
| getBodySlice | - |
| getBodySliceHtml | - |
| getBorderStyleType | - |
| getCellInfoInMergeData | Determines whether the cell(row, column) is within the range of the merged cells. |
| getCellValueType | - |
| getColorStyle | - |
| getDocsUpdateBody | - |
| getReverseDirection | - |
| getSheetBlocksFromSnapshot | - |
| getWorksheetUID | - |
| groupBy | - |
| handleJsonToDom | Convert rich text json to DOM |
| handleStyleToString | transform style object to string |
| hashAlgorithm | Copyright 2023-present DreamNum Inc. |
| horizontalLineSegmentsSubtraction | - |
| insertMatrixArray | - |
| insertTextToContent | - |
| isBlackColor | - |
| isBooleanString | Copyright 2023-present DreamNum Inc. |
| isCellCoverable | - |
| isCellV | - |
| isEmptyCell | - |
| isFormulaId | any string |
| isFormulaString | A string starting with an equal sign is a formula |
| isICellData | - |
| isInternalEditorID | - |
| isNullCell | - |
| isNumeric | Copyright 2023-present DreamNum Inc. |
| isRangesEqual | - |
| isRealNum | Determine whether it is a pure number, "12" and "12e+3" are both true |
| isSafeNumeric | - |
| isSameStyleTextRun | - |
| isUnitRangesEqual | - |
| isValidRange | - |
| isWhiteColor | - |
| makeArray | - |
| makeCellRangeToRangeData | - |
| makeCellToSelection | - |
| mergeOverrideWithDependencies | - |
| mergeSets | Merge the second set to the first set. |
| mergeWorksheetSnapshotWithDefault | This function is used to merge the user passed in snapshot with the default snapshot without changing the user's snapshot's reference. |
| moveMatrixArray | - |
| moveRangeByOffset | - |
| normalizeTextRuns | - |
| numberToABC | column subscript number to letters |
| numberToListABC | Column subscript numbers are converted to list-style letters, for example, after 25, it means AA BB CC, not AA AB AC |
| orderSearchArray | - |
| queryObjectMatrix | - |
| remove | Copyright 2023-present DreamNum Inc. |
| repeatStringNumTimes | Repeats the given string (first argument) num times (second argument). If num is not positive, an empty string is returned. |
| replaceInDocumentBody | - |
| requestImmediateMacroTask | Copyright 2023-present DreamNum Inc. |
| rotate | Rotate an array without mutating the original array. |
| runOnLifecycle | Register a dependency to be automatically instantiated when Univer progresses to the certain lifecycle stage. |
| searchArray | - |
| selectionToArray | Transform an IRange object to an array. |
| sequence | Execute tasks in sequence, if one of the tasks return false, the sequence will be stopped. |
| sequenceAsync | Execute promise tasks in sequence, if one of the tasks return false, the sequence will be stopped. |
| sequenceExecute | - |
| sequenceExecuteAsync | - |
| shallowEqual | - |
| sliceMatrixArray | - |
| sortRules | Copyright 2023-present DreamNum Inc. |
| sortRulesByDesc | - |
| sortRulesFactory | - |
| spliceArray | - |
| throttle | Copyright 2023-present DreamNum Inc. |
| toDisposable | - |
| transformDocumentDataToSnapshot | - |
| transformSnapshotToDocumentData | - |
| transformSnapshotToWorkbookData | Assemble a snapshot to a workbook. |
| transformWorkbookDataToSnapshot | - |