API Reference
@univerjs
@univerjs/core
interfaces
Idocumentbody

@univerjs/core v0.4.2Docs


Interface: 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

Needs to be changed: \r PARAGRAPH \n SECTION_BREAK

\b customBlock: Scenarios where customBlock, images, mentions, etc. do not participate in the document flow.

Table \x1A table start \x1B table row start \x1C table cell start \x1D table cell end \x1E table row end \x1F table end

Special ranges within the document flow::hyperlinks,field,structured document tags, bookmark,comment \x1F customRange start \x1E customRange end

Properties

PropertyTypeDescriptionDefined in
customBlocks?ICustomBlock[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:129 (opens in a new tab)
customDecorations?ICustomDecoration[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:138 (opens in a new tab)
customRanges?ICustomRange<Record<string, any>>[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:136 (opens in a new tab)
dataStreamstring-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:121 (opens in a new tab)
paragraphs?IParagraph[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:125 (opens in a new tab)
payloads?Record<string, string>for copy/paste, data of custom-range and other module it won't save to disksubmodules/univer/packages/core/src/types/interfaces/i-document-data.ts:144 (opens in a new tab)
sectionBreaks?ISectionBreak[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:127 (opens in a new tab)
tables?ICustomTable[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:131 (opens in a new tab)
textRuns?ITextRun[]-submodules/univer/packages/core/src/types/interfaces/i-document-data.ts:123 (opens in a new tab)

Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.