@univerjs-site/api

Enumerations

AbsoluteRefType

none: A1 row: A$1 column: $A1 all: $A$1

Enumeration Members

Enumeration Member	Value
`ALL`	`3`
`COLUMN`	`2`
`NONE`	`0`
`ROW`	`1`

AlignTypeH

Enumeration Members

Enumeration Member	Value
`BOTH`	`5`
`CENTER`	`0`
`DISTRIBUTE`	`6`
`INSIDE`	`1`
`LEFT`	`2`
`OUTSIDE`	`3`
`RIGHT`	`4`

AlignTypeV

Enumeration Members

Enumeration Member	Value
`BOTTOM`	`0`
`CENTER`	`1`
`INSIDE`	`2`
`OUTSIDE`	`3`
`TOP`	`4`

BaselineOffset

Enumeration Members

Enumeration Member	Value
`NORMAL`	`1`
`SUBSCRIPT`	`2`
`SUPERSCRIPT`	`3`

BlockType

Type of block

Enumeration Members

Enumeration Member	Value
`CUSTOM`	`1`
`DRAWING`	`0`

BooleanNumber

General Boolean Enum

Enumeration Members

Enumeration Member	Value
`FALSE`	`0`
`TRUE`	`1`

BorderStyleTypes

Border style types enum

Enumeration Members

Enumeration Member	Value
`DASH_DOT`	`5`
`DASH_DOT_DOT`	`6`
`DASHED`	`4`
`DOTTED`	`3`
`DOUBLE`	`7`
`HAIR`	`2`
`MEDIUM`	`8`
`MEDIUM_DASH_DOT`	`10`
`MEDIUM_DASH_DOT_DOT`	`11`
`MEDIUM_DASHED`	`9`
`NONE`	`0`
`SLANT_DASH_DOT`	`12`
`THICK`	`13`
`THIN`	`1`

BulletAlignment

The types of alignment for a bullet.

Enumeration Members

Enumeration Member	Value
`BOTH`	`4`
`BULLET_ALIGNMENT_UNSPECIFIED`	`0`
`CENTER`	`2`
`END`	`3`
`START`	`1`

CellValueType

General Boolean Enum

Enumeration Members

Enumeration Member	Value
`BOOLEAN`	`3`
`FORCE_STRING`	`4`
`NUMBER`	`2`
`STRING`	`1`

characterSpacingControlType

Enumeration Members

Enumeration Member	Value
`compressPunctuation`	`0`
`compressPunctuationAndJapaneseKana`	`1`
`doNotCompress`	`2`

ColumnSeparatorType

The style of column separators between columns.

Enumeration Members

Enumeration Member	Value
`BETWEEN_EACH_COLUMN`	`2`
`COLUMN_SEPARATOR_STYLE_UNSPECIFIED`	`0`
`NONE`	`1`

CustomDecorationType

Enumeration Members

Enumeration Member	Value
`COMMENT`	`0`
`DELETED`	`9999`

CustomRangeType

Enumeration Members

Enumeration Member	Value
`BOOKMARK`	`3`
`COMMENT`	`4`
`CUSTOM`	`5`
`DELTED`	`9999`
`FIELD`	`1`
`HYPERLINK`	`0`
`MENTION`	`6`
`SDT`	`2`
`UNI_FORMULA`	`7`

DashStyleType

The kinds of dashes with which linear geometry can be rendered.

Enumeration Members

Enumeration Member	Value
`DASH`	`3`
`DASH_STYLE_UNSPECIFIED`	`0`
`DOT`	`2`
`SOLID`	`1`

DocumentFlavor

Enumeration Members

Enumeration Member	Value
`MODERN`	`2`
`TRADITIONAL`	`1`
`UNSPECIFIED`	`0`

DrawingTypeEnum

Types of drawings, used to distinguish between images, shapes, charts, tables, SmartArt, videos, DrawingGroup, Unit, Dom, etc.

Enumeration Members

Enumeration Member	Value	Description
`DRAWING_CHART`	`2`	Chart
`DRAWING_DOM`	`8`	Dom element, allows inserting HTML elements as floating objects into the document
`DRAWING_GROUP`	`6`	Drawing group
`DRAWING_IMAGE`	`0`	Image
`DRAWING_SHAPE`	`1`	Shape, similar to shapes in Office, including circles, rectangles, lines, etc.
`DRAWING_SMART_ART`	`4`	SmartArt, similar to SmartArt in Office
`DRAWING_TABLE`	`3`	Table
`DRAWING_UNIT`	`7`	Univer object, allows inserting images, tables, documents, slides as floating objects into the document
`DRAWING_VIDEO`	`5`	Video
`UNRECOGNIZED`	`-1`	Unrecognized drawing type, requires user to determine

GridType

Enumeration Members

Enumeration Member	Value
`DEFAULT`	`0`
`LINES`	`1`
`LINES_AND_CHARS`	`2`
`SNAP_TO_CHARS`	`3`

HorizontalAlign

An enum that specifies the horizontal alignment of text.

Enumeration Members

Enumeration Member	Value
`BOTH`	`5`
`CENTER`	`2`
`DISTRIBUTED`	`6`
`JUSTIFIED`	`4`
`LEFT`	`1`
`RIGHT`	`3`
`UNSPECIFIED`	`0`

ListGlyphType

An enumeration of the supported glyph types.

Enumeration Members

Enumeration Member	Value	Description
`AIUEO`	`15`	-
`AIUEO_FULL_WIDTH`	`23`	-
`ARABIC_ABJAD`	`52`	-
`ARABIC_ALPHA`	`51`	-
`BULLET`	`0`	-
`CARDINAL_TEXT`	`9`	-
`CHICAGO`	`12`	-
`CHINESE_COUNTING`	`38`	-
`CHINESE_COUNTING_THOUSAND`	`40`	-
`CHINESE_LEGAL_SIMPLIFIED`	`39`	-
`CHOSUNG`	`26`	-
`CUSTOM`	`60`	-
`DECIMAL`	`2`	-
`DECIMAL_ENCLOSED_CIRCLE`	`21`	-
`DECIMAL_ENCLOSED_CIRCLE_CHINESE`	`29`	-
`DECIMAL_ENCLOSED_FULLSTOP`	`27`	-
`DECIMAL_ENCLOSED_PAREN`	`28`	-
`DECIMAL_FULL_WIDTH`	`17`	-
`DECIMAL_FULL_WIDTH2`	`22`	-
`DECIMAL_HALF_WIDTH`	`18`	-
`DECIMAL_ZERO`	`3`	-
`GANADA`	`25`	-
`HEBREW1`	`49`	-
`HEBREW2`	`50`	-
`HEX`	`11`	-
`HINDI_CONSONANTS`	`54`	-
`HINDI_COUNTING`	`56`	-
`HINDI_NUMBERS`	`55`	-
`HINDI_VOWELS`	`53`	-
`IDEOGRAPH_DIGITAL`	`13`	-
`IDEOGRAPH_ENCLOSED_CIRCLE`	`30`	-
`IDEOGRAPH_LEGAL_TRADITIONAL`	`35`	-
`IDEOGRAPH_TRADITIONAL`	`31`	-
`IDEOGRAPH_ZODIAC`	`32`	-
`IDEOGRAPH_ZODIAC_TRADITIONAL`	`33`	-
`IROHA`	`16`	-
`IROHA_FULL_WIDTH`	`24`	-
`JAPANESE_COUNTING`	`14`	-
`JAPANESE_DIGITAL_TEN_THOUSAND`	`20`	-
`JAPANESE_LEGAL`	`19`	-
`KOREAN_COUNTING`	`42`	-
`KOREAN_DIGITAL`	`41`	-
`KOREAN_DIGITAL2`	`44`	-
`KOREAN_LEGAL`	`43`	-
`LOWER_LETTER`	`5`	-
`LOWER_ROMAN`	`7`	-
`NONE`	`1`	-
`NUMBER_IN_DASH`	`48`	-
`ORDINAL`	`8`	Not yet achieved, aligned with Excel’s standards. 17.18.59 ST_NumberFormat (Numbering Format)
`ORDINAL_TEXT`	`10`	-
`RUSSIAN_LOWER`	`46`	-
`RUSSIAN_UPPER`	`47`	-
`TAIWANESE_COUNTING`	`34`	-
`TAIWANESE_COUNTING_THOUSAND`	`36`	-
`TAIWANESE_DIGITAL`	`37`	-
`THAI_COUNTING`	`59`	-
`THAI_LETTERS`	`57`	-
`THAI_NUMBERS`	`58`	-
`UPPER_LETTER`	`4`	-
`UPPER_ROMAN`	`6`	-
`VIETNAMESE_COUNTING`	`45`	-

LocaleType

Built-in locales.

Enumeration Members

Enumeration Member	Value
`EN_US`	`"enUS"`
`FA_IR`	`"faIR"`
`FR_FR`	`"frFR"`
`RU_RU`	`"ruRU"`
`VI_VN`	`"viVN"`
`ZH_CN`	`"zhCN"`
`ZH_TW`	`"zhTW"`

NamedStyleType

Types of name style

Enumeration Members

Enumeration Member	Value
`HEADING_1`	`4`
`HEADING_2`	`5`
`HEADING_3`	`6`
`HEADING_4`	`7`
`HEADING_5`	`8`
`HEADING_6`	`9`
`NAMED_STYLE_TYPE_UNSPECIFIED`	`0`
`NORMAL_TEXT`	`1`
`SUBTITLE`	`3`
`TITLE`	`2`

NumberUnitType

Enumeration Members

Enumeration Member	Value
`CHARACTER`	`2`
`LINE`	`1`
`PERCENT`	`4`
`PIXEL`	`3`
`POINT`	`0`

ObjectRelativeFromH

Enumeration Members

Enumeration Member	Value
`CHARACTER`	`2`
`COLUMN`	`1`
`INSIDE_MARGIN`	`4`
`LEFT_MARGIN`	`6`
`MARGIN`	`3`
`OUTSIDE_MARGIN`	`5`
`PAGE`	`0`
`RIGHT_MARGIN`	`7`

ObjectRelativeFromV

Enumeration Members

Enumeration Member	Value
`BOTTOM_MARGIN`	`5`
`INSIDE_MARGIN`	`6`
`LINE`	`2`
`MARGIN`	`3`
`OUTSIDE_MARGIN`	`7`
`PAGE`	`0`
`PARAGRAPH`	`1`
`TOP_MARGIN`	`4`

PageOrientType

Paper orientation, whether it’s portrait (vertical) or landscape (horizontal)

Enumeration Members

Enumeration Member	Value
`LANDSCAPE`	`1`
`PORTRAIT`	`0`

PositionedObjectLayoutType

The possible layouts of a [PositionedObject]

Enumeration Members

Enumeration Member	Value
`INLINE`	`0`
`WRAP_NONE`	`1`
`WRAP_POLYGON`	`2`
`WRAP_SQUARE`	`3`
`WRAP_THROUGH`	`4`
`WRAP_TIGHT`	`5`
`WRAP_TOP_AND_BOTTOM`	`6`

RANGE_TYPE

Enumeration Members

Enumeration Member	Value
`ALL`	`3`
`COLUMN`	`2`
`NORMAL`	`0`
`ROW`	`1`

SectionType

Represents how the start of the current section is positioned relative to the previous section.

Enumeration Members

Enumeration Member	Value
`CONTINUOUS`	`1`
`EVEN_PAGE`	`3`
`NEXT_PAGE`	`2`
`ODD_PAGE`	`4`
`SECTION_TYPE_UNSPECIFIED`	`0`

SpacingRule

Enumeration Members

Enumeration Member	Value	Description
`AT_LEAST`	`1`	Specifies that the height of the line shall be at least the value specified, but might be expanded to fit its content as needed.
`AUTO`	`0`	Specifies that the line spacing of the parent object shall be automatically determined by the size of its contents, with no predetermined minimum or maximum size.
`EXACT`	`2`	Specifies that the height of the line shall be exactly the value specified, regardless of the size of the contents of the contents.

TableAlignmentType

Enumeration Members

Enumeration Member	Value
`CENTER`	`1`
`END`	`2`
`START`	`0`

TableLayoutType

Enumeration Members

Enumeration Member	Value
`AUTO_FIT`	`0`
`FIXED`	`1`

TableRowHeightRule

Enumeration Members

Enumeration Member	Value
`AT_LEAST`	`1`
`AUTO`	`0`
`EXACT`	`2`

TableSizeType

Enumeration Members

Enumeration Member	Value
`SPECIFIED`	`1`
`UNSPECIFIED`	`0`

TableTextWrapType

Enumeration Members

Enumeration Member	Value
`NONE`	`0`
`WRAP`	`1`

TabStopAlignment

The alignment of the tab stop.

Enumeration Members

Enumeration Member	Value
`CENTER`	`2`
`END`	`3`
`START`	`1`
`TAB_STOP_ALIGNMENT_UNSPECIFIED`	`0`

TextDecoration

Types of text decoration

Enumeration Members

Enumeration Member	Value
`DASH`	`0`
`DASH_DOT_DOT_HEAVY`	`1`
`DASH_DOT_HEAVY`	`2`
`DASH_LONG`	`4`
`DASH_LONG_HEAVY`	`5`
`DASHED_HEAVY`	`3`
`DOT_DASH`	`6`
`DOT_DOT_DASH`	`7`
`DOTTED`	`8`
`DOTTED_HEAVY`	`9`
`DOUBLE`	`10`
`NONE`	`11`
`SINGLE`	`12`
`THICK`	`13`
`WAVE`	`14`
`WAVY_DOUBLE`	`15`
`WAVY_HEAVY`	`16`
`WORDS`	`17`

TextDirection

An enum that specifies the text direction of a cell.

Enumeration Members

Enumeration Member	Value
`LEFT_TO_RIGHT`	`1`
`RIGHT_TO_LEFT`	`2`
`UNSPECIFIED`	`0`

TextDirectionType

Direction of text

Enumeration Members

Enumeration Member	Value
`LRTBV`	`2`
`NORMAL`	`0`
`TBRL`	`1`

ThemeColorType

Theme color type enum

Enumeration Members

Enumeration Member	Value	Description
`ACCENT1`	`4`	-
`ACCENT2`	`5`	-
`ACCENT3`	`6`	-
`ACCENT4`	`7`	-
`ACCENT5`	`8`	-
`ACCENT6`	`9`	-
`DARK1`	`0`	TEXT
`DARK2`	`2`	-
`FOLLOWED_HYPERLINK`	`11`	-
`HYPERLINK`	`10`	LINK
`LIGHT1`	`1`	BACKGROUND
`LIGHT2`	`3`	-

VerticalAlign

An enum that specifies the vertical alignment of text.

Enumeration Members

Enumeration Member	Value
`BOTTOM`	`3`
`MIDDLE`	`2`
`TOP`	`1`
`UNSPECIFIED`	`0`

VerticalAlignmentType

The content alignments for a Shape or TableCell. The supported alignments correspond to predefined text anchoring types from the ECMA-376 standard.

Enumeration Members

Enumeration Member	Value
`BOTH`	`1`
`BOTTOM`	`4`
`CENTER`	`3`
`CONTENT_ALIGNMENT_UNSPECIFIED`	`0`
`TOP`	`2`

WrapStrategy

An enumeration of the strategies used to handle cell text wrapping.

Enumeration Members

Enumeration Member	Value	Description
`CLIP`	`2`	Lines that are longer than the cell width will be clipped. The text will never wrap to the next line unless the user manually inserts a new line. Example:
`OVERFLOW`	`1`	Lines that are longer than the cell width will be written in the next cell over, so long as that cell is empty. If the next cell over is non-empty, this behaves the same as CLIP . The text will never wrap to the next line unless the user manually inserts a new line. Example:
`UNSPECIFIED`	`0`	-
`WRAP`	`3`	Words that are longer than a line are wrapped at the character level rather than clipped. Example:

WrapTextType

Types of wrap text

Enumeration Members

Enumeration Member	Value
`BOTH_SIDES`	`0`
`LARGEST`	`3`
`LEFT`	`1`
`RIGHT`	`2`

Type Aliases

CellValue


type CellValue = string | number | boolean;

Cell value type

CustomData


type CustomData = Nullable<Record<..., ...>>;

DrawingType


type DrawingType = DrawingTypeEnum | number;

FHorizontalAlignment


type FHorizontalAlignment = "left" | "center" | "normal";

FontLine


type FontLine = "none" | "underline" | "line-through";

FontStyle


type FontStyle = "normal" | "italic";

FontWeight$1


type FontWeight$1 = "normal" | "bold";

FVerticalAlignment


type FVerticalAlignment = "top" | "middle" | "bottom";

IClipboardChangedParam


type IClipboardChangedParam = IBeforeClipboardChangeParam;

IClipboardPastedParam


type IClipboardPastedParam = IBeforeClipboardPasteParam;

IResources


type IResources = {
  data: ...;
  id: ...;
  name: ...;
 }[];

Type declaration

Name	Type
`data`	…
`id`?	…
`name`	…

IUpdateCommandParams


type IUpdateCommandParams = any;

SortColumnSpec


type SortColumnSpec = 
  | {
  ascending: ...;
  column: ...;
 }
  | number;

Classes

Class	Description
ConditionalFormatColorScaleRuleBuilder	-
ConditionalFormatDataBarRuleBuilder	-
ConditionalFormatHighlightRuleBuilder	-
ConditionalFormatIconSetRuleBuilder	-
FBlob	-
FChart	The facade class for the chart.
FChartBuilderBase	The base class for chart builder.The chart builder is used to create a chart in the sheet.For line chart , radar chart and pie chart, you use the LineChartBuilder, RadarChartBuilder and PieChartBuilder classes respectively.
FCollaboration	The Facade API object for the Collaboration module. It provides methods to interact with the Univer Collaboration backend server, such as loading Univer Sheets and subscribing to collaborators.
FConditionalFormattingBuilder	-
FDataValidation	-
FDataValidationBuilder	Builder for data validation rules. use FUniver `univerAPI.newDataValidation()` to create a new builder.
FDefinedName	-
FDefinedNameBuilder	-
FDocument	-
FEnum	-
FEventName	-
FFilter	This interface class provides methods to modify the filter settings of a worksheet.
FFormula	This interface class provides methods to modify the behavior of the operation formula.
FHooks	-
FMenu	This is the builder for adding a menu to Univer. You shall never construct this class by yourself. Instead, call `createMenu` of FUniver to create a instance.
FNetwork	This Facade provides a set of methods to make HTTP requests. You should not create an instance of this class directly, instead, use `getNetwork` of FUniver instead.
FOverGridImage	-
FOverGridImageBuilder	-
FPermission	-
FPivotTable	The facade class for the pivot table.Which uses to setting the pivot table fields configs.
FRange	Represents a range of cells in a sheet. You can call methods on this Facade API object to read contents or manipulate the range.
FSelection	Represents the active selection in the sheet.
FSheetHooks	-
FShortcut	The Facade API object to handle shortcuts in Univer
FSparkline	The facade class for the sparkline.
FSparklineGroup	The facade class for the sparkline group.Which uses to setting multiple sparklines, all sparkline in the same group will share the configs.
FSubmenu	This is the builder for add a menu that can contains submenus to Univer. You shall never construct this class by yourself. Instead, call `createSubmenu` of FUniver to create a instance.
FTextFinder	This interface class provides methods to find and replace text in the univer.
FTheadCommentBuilder	A builder for thread comment. use FUniver `univerAPI.newTheadComment()` to create a new builder.
FThreadComment	A class that represents a thread comment already in the sheet.
FUniver	The root Facade API object to interact with Univer. Please use `newAPI` static method to create a new instance.
FUserManager	-
FWorkbook	Facade API object bounded to a workbook. It provides a set of methods to interact with the workbook.
FWorksheet	A Facade API object bounded to a worksheet. It provides a set of methods to interact with the worksheet.
LineChartBuilder	The builder for creating a line chart.
PieChartBuilder	The builder for creating a pie chart.
RadarChartBuilder	The builder for creating a radar chart.

Interfaces

Interface	Description
IAbsoluteTransform	Copyright 2023-present DreamNum Inc.
IActiveSheetChangedEvent	Interface for sheet active changed event Contains information about the newly activated sheet
IBeforeActiveSheetChangeEvent	Interface for sheet active change event Contains information about the sheet that will become active
IBeforeClipboardChangeParam	-
IBeforeClipboardPasteParam	-
IBeforeGridlineColorChanged	Interface for event before gridline color change Triggered before changing the gridline color
IBeforeGridlineEnableChange	Interface for event before gridline enable/disable Triggered before changing the gridline visibility state
IBeforeOverGridImageChangeParam	-
IBeforeOverGridImageChangeParamObject	-
IBeforeOverGridImageInsertParam	-
IBeforeOverGridImageRemoveParam	-
IBeforeOverGridImageSelectParam	-
IBeforeSheetCommentAddEvent	Event interface triggered before a comment is added to a sheet IBeforeSheetCommentAddEvent
IBeforeSheetCommentDeleteEvent	Event interface triggered before a comment is deleted from a sheet IBeforeSheetCommentDeleteEvent
IBeforeSheetCommentUpdateEvent	Event interface triggered before a comment is updated in a sheet IBeforeSheetCommentUpdateEvent
IBeforeSheetCreateEventParams	Interface for event parameters triggered before creating a new worksheet Extends the base event interface and includes workbook and worksheet details
IBeforeSheetDataValidationAddEvent	Event interface triggered before adding a new data validation rule IBeforeSheetDataValidationAddEvent
IBeforeSheetDataValidationCriteriaUpdateEvent	Event interface triggered before updating a data validation rule’s criteria IBeforeSheetDataValidationCriteriaUpdateEvent
IBeforeSheetDataValidationDeleteAllEvent	Event interface triggered before deleting all data validation rules IBeforeSheetDataValidationDeleteAllEvent
IBeforeSheetDataValidationDeleteEvent	Event interface triggered before deleting a data validation rule IBeforeSheetDataValidationDeleteEvent
IBeforeSheetDataValidationOptionsUpdateEvent	Event interface triggered before updating a data validation rule’s options IBeforeSheetDataValidationOptionsUpdateEvent
IBeforeSheetDataValidationRangeUpdateEvent	Event interface triggered before updating a data validation rule’s ranges IBeforeSheetDataValidationRangeUpdateEvent
IBeforeSheetDeleteEvent	Interface for before sheet deletion event Contains information about the sheet that will be deleted
IBeforeSheetEditEndEventParams	Event interface triggered before cell editing ends IBeforeSheetEditEndEventParams
IBeforeSheetEditStartEventParams	Event interface triggered before cell editing starts IBeforeSheetEditStartEventParams
IBeforeSheetHideChangeEvent	Interface for before sheet hide state change event Contains information about the planned sheet visibility change
IBeforeSheetLinkAddEvent	-
IBeforeSheetLinkCancelEvent	-
IBeforeSheetLinkUpdateEvent	-
IBeforeSheetMoveEvent	Interface for before sheet move event Contains information about the planned sheet movement
IBeforeSheetNameChangeEvent	Interface for before sheet name change event Contains information about the planned sheet name change
IBeforeSheetPrintCancelEvent	Event triggered before print operation is canceled
IBeforeSheetPrintConfirmEvent	Event triggered before print settings are confirmed
IBeforeSheetPrintOpenEvent	Event triggered before sheet print dialog opens
IBeforeSheetTabColorChangeEvent	Interface for before sheet tab color change event Contains information about the planned sheet tab color change
IBorderData	Style properties of top, bottom, left and right border
IBorderStyleData	Style properties of border
IBullet	Properties of list
ICellData	Cell data
ICellEventParam	-
ICellHyperLink	-
IChartBuilderInfo	The chart builder info.
IChartBuildOptions	The chart build options.
IChartTextStyle	The chart text style.
IColorStyle	RGB color or theme color
IColumnData	Properties of column data
IColumnRange	-
ICommandEvent	Event interface for command execution ICommandEvent
ICrosshairHighlightColorChangedEvent	-
ICrosshairHighlightEnabledChangedEvent	-
ICustomBlock	Custom Block
ICustomDecoration	-
ICustomRange	Block element, link like, disabled to self nested
ICustomTable	-
IDistFromText	-
IDocCreatedParam	Event interface triggered when a document is created IDocCreatedParam
IDocDisposedEvent	Event interface triggered when a document is disposed IDocDisposedEvent
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
IDocsBorder	Properties of doc border
IDocStyleBase	Basics properties of doc style
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	-
IDrawings	Set of Drawings
IDrawingSearch	-
IDrawingSpace	-
IEventParamConfig	-
IFacadeClearOptions	-
IFBlobSource	-
IFCanvasPopup	-
IFComponentKey	-
IFICanvasFloatDom	-
IFooterData	Properties of doc footer
IFooters	Set of footer
IFreeze	-
IFSheetSparklineChangedEventParams	-
IFTextFinder	-
IFWorksheetLegacy	-
IGridlineChangedEvent	Interface for gridline change event Triggered when gridline visibility or color changes in a worksheet
IHeaderAndFooterBase	-
IHeaderData	Properties of doc header
IHeaders	Set of headers
IIndentStart	-
ILifeCycleChangedEvent	Event interface for lifecycle stage changes ILifeCycleChangedEvent
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
IMargin	-
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	-
IOverGridImageChangedParam	-
IOverGridImageInsertedParam	-
IOverGridImageRemovedParam	-
IOverGridImageSelectedParam	-
IPaddingData	Top,right,bottom,left padding
IParagraph	-
IParagraphBorder	Properties of paragraph border
IParagraphProperties	-
IParagraphStyle	Properties of paragraph style
IRange	Range data structure
IRangeLocation	-
IReferenceSource	-
IRotationSkewFlipTransform	-
IRowData	Properties of row data
IRowRange	-
IScale	-
IScrollEventParam	-
ISectionBreak	Properties of section break
ISectionBreakBase	-
ISectionColumnProperties	Properties of section column
ISelectionEventParam	-
IShading	Properties of shading
ISheetColumnHeaderEvent	-
ISheetCommentAddEvent	Event interface triggered after a comment is added to a sheet ISheetCommentAddEvent
ISheetCommentDeleteEvent	Event interface triggered after a comment is deleted from a sheet ISheetCommentDeleteEvent
ISheetCommentResolveEvent	Event interface triggered when a comment’s resolve status changes ISheetCommentResolveEvent
ISheetCommentUpdateEvent	Event interface triggered after a comment is updated in a sheet ISheetCommentUpdateEvent
ISheetCreatedEventParams	Interface for event parameters triggered after a worksheet is created Extends the base event interface and includes workbook and worksheet details
ISheetDataValidationChangedEvent	Event interface triggered when a data validation rule is changed ISheetDataValidationChangedEvent
ISheetDataValidatorStatusChangedEvent	Event interface triggered when a data validation status changes ISheetDataValidatorStatusChangedEvent
ISheetDeletedEvent	Interface for sheet deletion event Contains information about the sheet that was deleted
ISheetEditChangingEventParams	Event interface triggered while cell content is being changed ISheetEditChangingEventParams
ISheetEditEndedEventParams	Event interface triggered when cell editing ends ISheetEditEndedEventParams
ISheetEditStartedEventParams	Event interface triggered when cell editing starts ISheetEditStartedEventParams
ISheetHideChangedEvent	Interface for sheet hide state change event Contains information about the sheet visibility change
ISheetMovedEvent	Interface for sheet moved event Contains information about the sheet movement
ISheetNameChangedEvent	Interface for sheet name change event Contains information about the sheet name change
ISheetPrintCanceledEvent	Event triggered when print operation is canceled
ISheetPrintConfirmedEvent	Event triggered when print settings are confirmed by user
ISheetPrintOpenEvent	Event triggered when sheet print dialog is opened
ISheetRangeFilterClearedEventParams	The params of SheetRangeFilterCleared and SheetBeforeRangeFilterClear events.
ISheetRangeFilteredParams	The params of SheetRangeFiltered and SheetBeforeRangeFilter events.
ISheetRangeSortParams	-
ISheetRowHeaderEvent	-
ISheetSkeletonChangedEvent	-
ISheetTabColorChangedEvent	Interface for sheet tab color change event Contains information about the sheet tab color change
ISheetValueChangedEvent	Interface for sheet value changed event Contains information about the sheet value change
ISheetZoomEvent	-
ISize	Copyright 2023-present DreamNum Inc.
ISortColumn	-
IStyleBase	Basics properties of cell style
IStyleData	Properties of cell style
ITable	Properties of table
ITableAnchor	-
ITableCell	Properties of table cell
ITableCellBorder	Properties of cell border
ITableCellMargin	-
ITableColumn	-
ITableRow	Properties of row of table
ITableRowSize	-
ITables	-
ITabStop	A tab stop within a paragraph.
ITextDecoration	Properties of text decoration
ITextRotation	-
ITextRun	A ParagraphElement that represents a run of text that all has the same styling.
ITextStyle	Properties of text style
ITransformState	Copyright 2023-present DreamNum Inc.
IWidthInTableSize	-
IWorkbookCreateParam	Interface for workbook creation parameters Extends the base event interface and includes workbook initialization details
IWorkbookData	Snapshot of a workbook.
IWorkbookDisposedEvent	Interface for workbook disposal event Contains information about the disposed workbook including its snapshot data
IWorksheetData	Snapshot of a worksheet.