@univerjs/engine-render v0.1.17 • Docs
Class: DocumentViewModel
Implements
IDisposable
Constructors
new DocumentViewModel()
new DocumentViewModel(_documentDataModel): DocumentViewModel
Parameters
Parameter | Type |
---|---|
_documentDataModel | DocumentDataModel |
Returns
Defined in
Properties
Property | Type | Default value | Defined in |
---|---|---|---|
children | DataStreamTreeNode [] | [] | submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:24 (opens in a new tab) |
footerTreeMap | Map <string , DocumentViewModel > | undefined | submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:40 (opens in a new tab) |
headerTreeMap | Map <string , DocumentViewModel > | undefined | submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:38 (opens in a new tab) |
Methods
_transformToTree()
protected _transformToTree(dataStream): DataStreamTreeNode[]
Parameters
Parameter | Type |
---|---|
dataStream | string |
Returns
DataStreamTreeNode
[]
Defined in
delete()
delete(currentIndex, textLength): void
Parameters
Parameter | Type |
---|---|
currentIndex | number |
textLength | number |
Returns
void
Defined in
dispose()
dispose(): void
Returns
void
Implementation of
IDisposable.dispose
Defined in
getBody()
getBody(): undefined | IDocumentBody
Returns
undefined
| IDocumentBody
Defined in
getCustomBlock()
getCustomBlock(index): undefined | ICustomBlock
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| ICustomBlock
Defined in
getCustomRange()
getCustomRange(index): undefined | ICustomRange
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| ICustomRange
Defined in
getDataModel()
getDataModel(): DocumentDataModel
Returns
Defined in
getLastIndex()
getLastIndex(): number
Returns
number
Defined in
getParagraph()
getParagraph(index): undefined | IParagraph
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| IParagraph
Defined in
getPositionInParent()
getPositionInParent(): number
Returns
number
Defined in
getSectionBreak()
getSectionBreak(index): undefined | ISectionBreak
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| ISectionBreak
Defined in
getSelfOrHeaderFooterViewModel()
getSelfOrHeaderFooterViewModel(segmentId?): DocumentViewModel
Parameters
Parameter | Type |
---|---|
segmentId ? | string |
Returns
Defined in
getTable()
getTable(index): undefined | ITable
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| ITable
Defined in
getText()
getText(): string
Get pure text content in the given range.
Returns
string
Defined in
getTextRun()
getTextRun(index): undefined | ITextRun
textRun matches according to the selection. If the text length is 10, then the range of textRun is from 0 to 11.
Parameters
Parameter | Type |
---|---|
index | number |
Returns
undefined
| ITextRun
Defined in
getTextRunRange()
getTextRunRange(startIndex, endIndex): ITextRun[]
Parameters
Parameter | Type | Default value |
---|---|---|
startIndex | number | 0 |
endIndex | number | undefined |
Returns
ITextRun
[]
Defined in
insert()
insert(insertBody, insertIndex): void
Parameters
Parameter | Type | Default value |
---|---|---|
insertBody | IDocumentBody | undefined |
insertIndex | number | 0 |
Returns
void
Defined in
reset()
reset(documentDataModel): void
Parameters
Parameter | Type |
---|---|
documentDataModel | DocumentDataModel |
Returns
void
Defined in
resetCache()
resetCache(): void
Returns
void
Defined in
selfPlus()
selfPlus(len, index): void
Parameters
Parameter | Type |
---|---|
len | number |
index | number |
Returns
void