@univerjscoreReadme

@univerjs/core v0.5.0-beta.1Docs


@univerjs/core

Other

JSONXActions

Renames and re-exports JSONOp


JSONXPath

Renames and re-exports Path

Object

FunctionDescription
mergeRecursively merges own and inherited enumerable properties of source objects into the destination object, skipping source properties that resolve to undefined. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.
mergeWithThis method is like _.merge except that it accepts customizer which is invoked to produce the merged values of the destination and source properties. If customizer returns undefined merging is handled by the method instead. The customizer is invoked with seven arguments: (objValue, srcValue, key, object, source, stack).

Other

Reference, Namespace, Enumeration, Class, Interface, Type alias, Variable, FunctionDescription
JSONXActions-
JSONXPath-
JSON1-
textDiff-
AbsoluteRefTypenone: A1 row: A$1 column: $A1 all: $A$1
AlignTypeH-
AlignTypeV-
ArrangeTypeEnum-
ArrowsAndMarkersShapes-
AutoFillSeriesCopyright 2023-present DreamNum Inc.
BaselineOffset-
BasicShapesCopyright 2023-present DreamNum Inc.
BlockTypeType of block
BooleanNumberGeneral Boolean Enum
BorderStyleTypesCopyright 2023-present DreamNum Inc.
BorderType-
BulletAlignmentThe types of alignment for a bullet.
CellValueTypeGeneral Boolean Enum
characterSpacingControlType-
ColorTypeCopyright 2023-present DreamNum Inc.
ColumnSeparatorTypeThe style of column separators between columns.
CommandTypeThe type of a command.
CommonHideTypesCopyright 2023-present DreamNum Inc.
CopyPasteTypeCopyright 2023-present DreamNum Inc.
CustomDecorationType-
CustomRangeType-
DashStyleTypeThe kinds of dashes with which linear geometry can be rendered.
DataStreamTreeNodeTypeCopyright 2023-present DreamNum Inc.
DataStreamTreeTokenType-
DataValidationErrorStyleCopyright 2023-present DreamNum Inc.
DataValidationImeModeCopyright 2023-present DreamNum Inc.
DataValidationOperatorCopyright 2023-present DreamNum Inc.
DataValidationRenderModeCopyright 2023-present DreamNum Inc.
DataValidationStatusCopyright 2023-present DreamNum Inc.
DataValidationTypeCopyright 2023-present DreamNum Inc.
DeleteDirectionCopyright 2023-present DreamNum Inc.
DeveloperMetadataVisibilityCopyright 2023-present DreamNum Inc.
DimensionCopyright 2023-present DreamNum Inc.
DirectionCopyright 2023-present DreamNum Inc.
DOC_RANGE_TYPE-
DocStyleType-
DocumentFlavor-
DrawingTypeEnum-
EXTENSION_NAMESCopyright 2023-present DreamNum Inc.
FollowNumberWithTypeFollow the space after the list
FontItalicFontItalic
FontStyleTypeTypes of font style
FontWeightFontWeight
FormatTypeCopyright 2023-present DreamNum Inc.
GlyphTypeAn enumeration of the supported glyph types.
GridType-
HorizontalAlignAn enum that specifies the horizontal alignment of text.
InterceptorEffectEnum-
InterpolationPointTypeCopyright 2023-present DreamNum Inc.
LifecycleStagesThis enum defines multiple lifecycle stages in Univer SDK.
LocaleTypeBuilt-in locales.
LogLevel-
LookUp-
MentionTypeCopyright 2023-present DreamNum Inc.
NamedStyleTypeTypes of name style
NumberUnitType-
ObjectRelativeFromH-
ObjectRelativeFromV-
OtherShapes-
PageElementType-
PageOrientTypePaper orientation, whether it’s portrait (vertical) or landscape (horizontal)
PageType-
ParagraphElementType-
PermissionStatus-
PositionedObjectLayoutTypeThe possible layouts of a [PositionedObject]
PresetListType-
ProtectionTypeCopyright 2023-present DreamNum Inc.
Quantity-
QuickListType-
RANGE_DIRECTION-
RANGE_TYPE-
RelativeDateCopyright 2023-present DreamNum Inc.
RelativeSlideLink-
SectionTypeRepresents how the start of the current section is positioned relative to the previous section.
SheetTypesCopyright 2023-present DreamNum Inc.
SliceBodyType-
SpacingRule-
SpecialShapes-
TableAlignmentType-
TableLayoutType-
TableRowHeightRule-
TableSizeType-
TableTextWrapType-
TabStopAlignmentThe alignment of the tab stop.
TextDecorationTypes of text decoration
TextDirectionCopyright 2023-present DreamNum Inc.
TextDirectionTypeDirection of text
TextXActionType-
ThemeColors-
ThemeColorTypeCopyright 2023-present DreamNum Inc.
UniverInstanceType-
UpdateDocsAttributeTypeCopyright 2023-present DreamNum Inc.
VerticalAlignAn enum that specifies the vertical alignment of text.
VerticalAlignmentTypeThe content alignments for a Shape or TableCell. The supported alignments correspond to predefined text anchoring types from the ECMA-376 standard.
WrapStrategyAn enumeration of the strategies used to handle cell text wrapping.
WrapTextTypeTypes of wrap text
ActionIterator-
AsyncInterceptorManager-
AuthzIoLocalServiceDo not use the mock implementation in a production environment as it is a minimal version.
BuildTextUtils-
Color-
ColorBuilder-
ColorKit-
CommandServiceThe service to register and execute commands.
ConfigService-
ContextService-
CustomCommandExecutionErrorCopyright 2023-present DreamNum Inc.
DesktopLogService-
Disposable-
DisposableCollection-
DocumentDataModel-
ErrorService-
EventStateA class serves as a medium between the observable and its observers
EventSubjectThis 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.
FBaseFBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.
FHooksFBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.
FUniverFBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.
HLSColor-
Injector-
InterceptorManager-
JSONX-
LifecycleServiceThis 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.
LocaleServiceThis service provides i18n and timezone / location features to other modules.
LocalUndoRedoServiceThis UndoRedoService is local.
LRUHelper-
LRUMap-
MemoryCursorCopyright 2023-present DreamNum Inc.
MentionIOLocalService-
ObjectMatrixA two-dimensional array represented by a two-level deep object and provides an array-like API
PermissionService-
PluginPlug-in base class, all plug-ins must inherit from this base class. Provide basic methods.
PluginServiceThis service manages plugin registration.
RangeAccess and modify spreadsheet ranges.
RCDisposable-
RectangleThis class provides a set of methods to calculate IRange.
RediError-
RefAliasCopyright 2023-present DreamNum Inc.
RegistryCopyright 2023-present DreamNum Inc.
RegistryAsMapAdd extension modules statically when the plugin is initialized, so that the plugin can register these extension modules uniformly
ResourceManagerService-
RgbColor-
RTree-
RxDisposable-
SheetViewModel-
SlideDataModelThe base class for all units.
StylesStyles in a workbook, cells locate styles based on style IDs
TextX-
ThemeColor-
ThemeService-
ToolsUniversal tool library
UnitModelThe base class for all units.
Univer-
UniverInstanceServiceIUniverInstanceService holds all the current univer instances and provides a set of methods to add and remove univer instances.
UserManagerService-
WorkbookAccess and create Univer Sheets files
WorksheetThe model of a Worksheet.
AsyncDependencyItem-
AsyncHook-
ClassDependencyItem-
Ctor-
FactoryDependencyItem-
IAbsoluteTransformCopyright 2023-present DreamNum Inc.
IAccessor-
IAddCustomRangeTextXParam-
IAuthzIoService-
IBorderDataStyle properties of top, bottom, left and right border
IBorderStyleDataStyle properties of border
IBulletProperties of list
ICellDataCell data
ICellDataForSheetInterceptorCell data
ICellInfoICellInfo has the same properties as ISelectionCell, but the name ICellInfo might be more semantically appropriate in some contexts.
ICellInterceptor-
ICellMarks-
ICellMarksStyle-
ICellRenderContext-
ICellWithCoordSingleCell & coordinate and mergeRange.
IChartPropertiesChartProperties
IColAutoWidthInfo-
IColorFormat of RBGA color
IColorStyleRGB color or theme color
IColumnDataProperties of column data
IColumnRange-
ICommandIn Univer, all data modifications need to be executed through commands. The command-based approach can better track changes in values, implement functions such as undo, redo, and collaborative editing, handle complex associated logic between functions, etc.
ICommandInfoThis object represents an execution of a command.
ICommandServiceThe service to register and execute commands.
IConfigService-
IContextService-
ICopyToOptionsDataOption of copyTo function
ICropPropertiesProperties of crop image
ICustomBlockCustom Block
ICustomDecoration-
ICustomDecorationForInterceptor-
ICustomRangeBlock element, link like, disabled to self nested
ICustomRangeForInterceptorBlock element, link like, disabled to self nested
ICustomTable-
IDataValidationRule-
IDataValidationRuleBase-
IDataValidationRuleInfo-
IDataValidationRuleOptions-
IDeleteActionDelete mutation is used to delete text at the given position.
IDeleteCustomRangeParam-
IDisposable-
IDistFromText-
IDocDrawingBaseProperties 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)
IDocDrawingPositionProperties of a draw object
IDocMention-
IDocsBorderProperties of doc border
IDocStyle-
IDocStyleBaseBasics properties of doc style
IDocStylesSet of IStyles
IDocumentBodyProperties 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
IDocumentDataProperties of document
IDocumentLayout-
IDocumentRenderConfigthe 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-
IDocumentStyleBasics properties of doc style
IDrawingParam-
IDrawingsSet of Drawings
IDrawingSearch-
IDrawingSpace-
IError-
IEventObserver-
IExecutionOptions-
IFooterDataProperties of doc footer
IFootersSet of footer
IFreeze-
IGridRangeRange data of grid
IHeaderAndFooterBase-
IHeaderDataProperties of doc header
IHeadersSet of headers
IHyperlink-
IImage-
IImagePropertiesCopyright 2023-present DreamNum Inc.
IIndentStart-
IInsertActionInsert mutation is used to insert text (maybe with rich text properties) at the given position.
IInterceptor-
ILanguagePack-
IListDataThe properties of a list which describe the look and feel of bullets belonging to paragraphs associated with a list.
IListMentionParam-
IListMentionResponse-
IListsSet of lists
ILocales-
ILocalStorageService-
ILogService-
IMargin-
IMention-
IMentionIOService-
IMultiCommandA command that may have multiple implementations. Each implementation should have different priority and preconditions callback to determine which implementation should be executed.
IMutationCommandType.MUTATION should implement this interface.
IMutationCommonParams-
IMutationInfoThis object represents an execution of a CommandType.MUTATION
INeedCheckDisposable-
INestingLevelContains properties describing the look and feel of a list bullet at a given level of nesting.
INumberUnit-
IObjectArrayPrimitiveType-
IObjectMatrixPrimitiveTypeObject Matrix Primitive Type
IObjectPositionH-
IObjectPositionV-
IOffset-
IOperationCommandType.OPERATION should implement this interface.
IOperationInfoThis object represents an execution of a CommandType.OPERATION
IOptionDataWhether to clear only the contents. Whether to clear only the format; note that clearing format also clears data validation rules.
IOutline-
IPaddingDataTop,right,bottom,left padding
IPageElement-
IParagraph-
IParagraphBorderProperties of paragraph border
IParagraphProperties-
IParagraphRange-
IParagraphStyleProperties of paragraph style
IPermissionParam-
IPermissionPoint-
IPermissionService-
IPermissionTypes-
IPlaceholder-
IPositionProperties of selection data
IRangeRange data structure
IRangeArrayDataOne of the range types,
IRangeCellDataThe row and column numbers represent a cell
IRangeWithCoordProperties of selection data
IRectLTRB-
IRectXYWH-
IReferenceSource-
IReplaceSelectionTextXParams-
IResourceHook-
IResourceLoaderService-
IResourceManagerService-
IRetainActionRetain mutation is used to move the cursor or to update properties of the text in the given range.
IRgbColorCopyright 2023-present DreamNum Inc.
IRichTextProps-
IRotationSkewFlipTransform-
IRowAutoHeightInfo-
IRowColIterCopyright 2023-present DreamNum Inc.
IRowDataProperties of row data
IRowRange-
IRTreeItemRange data of Unit
IScale-
ISectionBreakProperties of section break
ISectionBreakBase-
ISectionColumnPropertiesProperties of section column
ISelection-
ISelectionCellRange & SingleCell & isMerged. startRow: number; startColumn: number; endRow: number; endColumn: number;
ISelectionCellWithMergeInfo-
ISequenceExecuteResultCopyright 2023-present DreamNum Inc.
IShadingProperties of shading
IShapeIShape
IShapePropertiesShapeProperties
ISheetDataValidationRule-
ISingleCell-
ISizeCopyright 2023-present DreamNum Inc.
ISlideData-
ISlidePage-
ISrcRect-
IStyleBaseBasics properties of cell style
IStyleDataProperties of cell style
IStyleSheet-
ITableProperties of table
ITableAnchor-
ITableCellProperties of table cell
ITableCellBorderProperties of cell border
ITableCellMargin-
ITableColumn-
ITableOfContent-
ITableRowProperties of row of table
ITableRowSize-
ITables-
ITabStopA tab stop within a paragraph.
ITextDecorationProperties of text decoration
ITextRange-
ITextRangeParam-
ITextRangeStart-
ITextRotation-
ITextRunA ParagraphElement that represents a run of text that all has the same styling.
ITextStyleProperties of text style
ITransformState-
ITypeMentionList-
IUndoRedoCommandInfos-
IUndoRedoCommandInfosByInterceptor-
IUndoRedoItem-
IUndoRedoService-
IUndoRedoStatus-
IUnitRangeRange data of Unit
IUnitRangeName-
IUnitRangeWithNameRange data of Unit
IUniverConfig-
IUniverInstanceServiceIUniverInstanceService holds all the current univer instances and provides a set of methods to add and remove univer instances.
IUser-
IWidthInTableSize-
IWorkbookDataSnapshot of a workbook.
IWorksheetDataSnapshot of a worksheet.
ValueDependencyItem-
CellValueCell value type
CommandListener-
CustomData-
DeepReadonly-
Dependency-
DependencyIdentifier-
DependencyItem-
DependencyOverrideOverrides 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.
DependencyPair-
DrawingType-
IColumnStartEndDataColumn data type
IComposeInterceptors-
IdentifierDecorator-
IHyperLinkCustomRange-
IMentionCustomRange-
InterceptorHandler-
IRangeStringDataOne of the range types,
IRangeTyperange types
IResources-
IRowStartEndDataRow data type
LanguageValueCopyright 2023-present DreamNum Inc.
NullableCopyright 2023-present DreamNum Inc.
PluginCtor-
PresetGeometryType-
RangePermissionPointConstructor-
SerializableCopyright 2023-present DreamNum Inc.
ShapeType20.1.9.18 prstGeom (Preset geometry)
SyncDependencyItem-
TextXAction-
TPriority-
UnitType-
WorkbookPermissionPointConstructor-
WorkSheetPermissionPointConstructor-
COLORS-
DEFAULT_CELLUsed as an init cell return value
DEFAULT_DOC-
DEFAULT_DOCUMENT_SUB_COMPONENT_IDCopyright 2023-present DreamNum Inc.
DEFAULT_EMPTY_DOCUMENT_VALUE-
DEFAULT_RANGEUsed as an illegal range return value
DEFAULT_RANGE_ARRAYUsed as an illegal range array return value
DEFAULT_SELECTIONUsed as an init selection return value
DEFAULT_SLIDE-
DEFAULT_STYLESDefault styles.
DEFAULT_WORKSHEET_COLUMN_COUNT-
DEFAULT_WORKSHEET_COLUMN_COUNT_KEY-
DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT-
DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT_KEY-
DEFAULT_WORKSHEET_COLUMN_WIDTH-
DEFAULT_WORKSHEET_COLUMN_WIDTH_KEY-
DEFAULT_WORKSHEET_ROW_COUNT-
DEFAULT_WORKSHEET_ROW_COUNT_KEY-
DEFAULT_WORKSHEET_ROW_HEIGHT-
DEFAULT_WORKSHEET_ROW_HEIGHT_KEY-
DEFAULT_WORKSHEET_ROW_TITLE_WIDTH-
DEFAULT_WORKSHEET_ROW_TITLE_WIDTH_KEY-
DOCS_FORMULA_BAR_EDITOR_UNIT_ID_KEY-
DOCS_NORMAL_EDITOR_UNIT_ID_KEY-
DOCS_ZEN_EDITOR_UNIT_ID_KEY-
EDITOR_ACTIVATED-
FOCUSING_COMMON_DRAWINGSThe focusing state of the common drawings.
FOCUSING_DOC-
FOCUSING_EDITOR_BUT_HIDDEN-
FOCUSING_EDITOR_INPUT_FORMULA-
FOCUSING_EDITOR_STANDALONE-
FOCUSING_FX_BAR_EDITORThe focusing state of the formula editor (Fx bar).
FOCUSING_PANEL_EDITORThe focusing state of the editor in side panel, such as Chart Editor Panel.
FOCUSING_SHEET-
FOCUSING_SLIDE-
FOCUSING_UNITCopyright 2023-present DreamNum Inc.
FOCUSING_UNIVER_EDITOR-
FOCUSING_UNIVER_EDITOR_STANDALONE_SINGLE_MODE-
FORMULA_EDITOR_ACTIVATED-
Inject-
IS_ROW_STYLE_PRECEDE_COLUMN_STYLE-
Many-
MOVE_BUFFER_VALUE-
NilCommand-
Optional-
PRESET_LIST_TYPE-
QuickListTypeMap-
RediContext-
RedoCommand-
RedoCommandId-
RGB_PAREN-
RGBA_PAREN-
ROTATE_BUFFER_VALUE-
Selfwhen resolving this dependency, only search the current injector
SHEET_EDITOR_UNITS-
skipParseTagNamesCopyright 2023-present DreamNum Inc.
SkipSelfwhen resolving this dependency, skip the current injector
THEME_COLORS-
UndoCommand-
UndoCommandId-
WithNewAlways initialize a new instance of that dependency instead of getting the cached instance from the injector.
ABCToNumberCopyright 2023-present DreamNum Inc.
addLinkToDocumentModel-
afterInitApply-
afterTime-
awaitTimeCopyright 2023-present DreamNum Inc.
binarySearchArrayReturn the index of the first value in an ascending array that is greater than the target value. If there is no value greater than the target, return last index.
binSearchFirstGreaterThanTargetReturn the index of the last index in an ascending array which value is just greater than the target. If there is no value greater than the target, return arr.length - 1.
bufferDebounceTime-
cellToRangeCovert row/column to range object
checkForSubstrings-
checkIfMove-
checkParagraphHasBullet-
checkParagraphHasIndent-
checkParagraphHasIndentByStyle-
codeToBlobCopyright 2023-present DreamNum Inc.
composeBody-
composeInterceptorsA helper to compose a certain type of interceptors.
composeStylescompose styles by priority, the latter will overwrite the former
concatMatrixArray-
connectDependencies-
connectInjector-
convertBodyToHtml-
convertCellToRangeData type convert, convert ICellWithCoord to IRangeWithCoord
covertTextRunToHtml-
createAsyncInterceptorKey-
createDefaultUser-
createIdentifierCreate a dependency identifier
createInterceptorKey-
createInternalEditorID-
createRowColIter-
dayjs-
debounceCreates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function return the result of the last func invocation.
dedupeDeduplicate an array.
deepCompare-
deleteContent-
DependentOnUse this decorator to declare dependencies among plugins. If a dependent plugin is not registered yet, Univer will automatically register it with no configuration.
extractPureTextFromCellGet pure text in a cell.
forwardRef-
fromCallbackCreates an observable from a callback function.
fromEventSubject-
fromObservable-
generateRandomId-
getGets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.
getArrayLength-
getBodySlice-
getBodySliceHtml-
getBorderStyleType-
getCellInfoInMergeDataDetermines whether the cell(row, column) is within the range of the merged cells.
getCellValueType-
getColorStyle-
getCustomDecorationSlice-
getCustomRangeSlice-
getDocsUpdateBody-
getIntersectRangeComputes the intersection of two ranges. If there is an overlap between the two ranges, returns a new range representing the intersection. If there is no overlap, returns null.
getOriginCellValue-
getReverseDirection-
getWorksheetUID-
groupBy-
handleStyleToStringtransform style object to string
hashAlgorithmCopyright 2023-present DreamNum Inc.
horizontalLineSegmentsSubtraction-
IAuthzIoService-
ICommandServiceThe identifier of the command service.
IConfigServiceIConfig provides universal configuration for the whole application.
IContextService-
ILocalStorageService-
ILogService-
IMentionIOService-
insertMatrixArray-
insertTextToContent-
IPermissionService-
IResourceLoaderService-
IResourceManagerService-
isAsyncDependencyItem-
isAsyncHook-
isBlackColor-
isBooleanStringCopyright 2023-present DreamNum Inc.
isCellCoverable-
isCellV-
isClassDependencyItem-
isCtor-
isDisposable-
isEmptyCell-
isFactoryDependencyItem-
isFormulaIdany string
isFormulaStringA string starting with an equal sign is a formula
isICellData-
isInternalEditorID-
isNodeEnv-
isNullCell-
isNumericCopyright 2023-present DreamNum Inc.
isRangesEqual-
isRealNum-
isSafeNumeric-
isSameStyleTextRun-
isUnitRangesEqual-
isValidRange-
isValueDependencyItem-
isWhiteColor-
IUndoRedoService-
IUniverInstanceService-
makeArray-
makeCellRangeToRangeData-
makeCellToSelection-
makeCustomRangeStreamWrap your stream in a pair of custom range tokens.
mergeOverrideWithDependencies-
mergeSetsMerge the second set to the first set.
mergeWorksheetSnapshotWithDefaultThis function is used to merge the user passed in snapshot with the default snapshot without changing the user’s snapshot’s reference.
mixinClassMixin some methods to targetObject as prototype, the static methods will not be mixed in
moveMatrixArray-
moveRangeByOffset-
nameCharacterCheckThe name you entered for the worksheet or chart is invalid. Please ensure:
normalizeBody-
normalizeTextRuns-
numberToABCcolumn subscript number to letters
numberToListABCColumn subscript numbers are converted to list-style letters, for example, after 25, it means AA BB CC, not AA AB AC
numfmt-
queryObjectMatrix-
RediConsumer-
RediProvider-
registerDependenciesRegister the dependencies to the injector.
removeCopyright 2023-present DreamNum Inc.
repeatStringNumTimesRepeats the given string (first argument) num times (second argument). If num is not positive, an empty string is returned.
replaceInDocumentBody-
requestImmediateMacroTaskCopyright 2023-present DreamNum Inc.
rotateRotate an array without mutating the original array.
searchArrayFind value in the data that is just greater than the target; if there are equal values greater than the target, select the last one. If firstMatch is true, then return the index of the first number greater than the target. see #univer/pull/3903
searchInOrderedArrayReturn the index of the first value in an ascending array that is greater than the target value. If there is no value greater than the target, return -1.
selectionToArrayTransform an IRange object to an array.
sequenceExecute tasks in sequence, if one of the tasks return false, the sequence will be stopped.
sequenceAsyncExecute promise tasks in sequence, if one of the tasks return false, the sequence will be stopped.
sequenceExecute-
sequenceExecuteAsync-
setSets the value at path of object. If a portion of path doesn’t exist it’s created. Arrays are created for missing index properties while objects are created for all other missing properties. Use _.setWith to customize path creation.
setDependenciesRegister dependencies on a class.
shallowEqualCopyright 2023-present DreamNum Inc.
sliceMatrixArray-
sortRulesCopyright 2023-present DreamNum Inc.
sortRulesByDesc-
sortRulesFactory-
spliceArray-
splitIntoGridSplit ranges into aligned smaller ranges
takeAfterAn operator that would complete the stream once a condition is met. Consider it as a shortcut of takeUntil.
textDiff-
throttleCopyright 2023-present DreamNum Inc.
toDisposable-
touchDependenciesTouch a group of dependencies to ensure they are instantiated.
updateAttributeByDelete-
updateAttributeByInsert-
useDependency-
useDependencyContextsubscribe to an observable value from a service, creating a context for it so it child component won’t have to subscribe again and cause unnecessary
useDependencyContextValue-
useDependencyValueunwrap an observable value, return it to the component for rendering, and trigger re-render when value changes
useInjector-
useObservable-
useUpdateBindersubscribe to a signal that emits whenever data updates and re-render
WithDependency-