@univerjs/engine-render v0.1.17 • Docs

Class: DocumentViewModel

Implements

IDisposable

Constructors

new DocumentViewModel()

new DocumentViewModel(_documentDataModel): DocumentViewModel

Parameters

Parameter	Type
`_documentDataModel`	`DocumentDataModel`

Returns

DocumentViewModel

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:42 (opens in a new tab)

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

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:385 (opens in a new tab)

delete()

delete(currentIndex, textLength): void

Parameters

Parameter	Type
`currentIndex`	`number`
`textLength`	`number`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:191 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:52 (opens in a new tab)

getBody()

getBody(): undefined | IDocumentBody

Returns

undefined | IDocumentBody

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:70 (opens in a new tab)

getCustomBlock()

getCustomBlock(index): undefined | ICustomBlock

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ICustomBlock

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:341 (opens in a new tab)

getCustomRange()

getCustomRange(index): undefined | ICustomRange

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ICustomRange

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:372 (opens in a new tab)

getDataModel()

getDataModel(): DocumentDataModel

Returns

DocumentDataModel

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:74 (opens in a new tab)

getLastIndex()

getLastIndex(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:66 (opens in a new tab)

getParagraph()

getParagraph(index): undefined | IParagraph

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | IParagraph

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:244 (opens in a new tab)

getPositionInParent()

getPositionInParent(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:62 (opens in a new tab)

getSectionBreak()

getSectionBreak(index): undefined | ISectionBreak

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ISectionBreak

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:225 (opens in a new tab)

getSelfOrHeaderFooterViewModel()

getSelfOrHeaderFooterViewModel(segmentId?): DocumentViewModel

Parameters

Parameter	Type
`segmentId`?	`string`

Returns

DocumentViewModel

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:78 (opens in a new tab)

getTable()

getTable(index): undefined | ITable

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ITable

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:357 (opens in a new tab)

getText()

getText(): string

Get pure text content in the given range.

Returns

string

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:198 (opens in a new tab)

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

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:313 (opens in a new tab)

getTextRunRange()

getTextRunRange(startIndex, endIndex): ITextRun[]

Parameters

Parameter	Type	Default value
`startIndex`	`number`	`0`
`endIndex`	`number`	`undefined`

Returns

ITextRun[]

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:259 (opens in a new tab)

insert()

insert(insertBody, insertIndex): void

Parameters

Parameter	Type	Default value
`insertBody`	`IDocumentBody`	`undefined`
`insertIndex`	`number`	`0`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:102 (opens in a new tab)

reset()

reset(documentDataModel): void

Parameters

Parameter	Type
`documentDataModel`	`DocumentDataModel`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:94 (opens in a new tab)

resetCache()

resetCache(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:216 (opens in a new tab)

selfPlus()

selfPlus(len, index): void

Parameters

Parameter	Type
`len`	`number`
`index`	`number`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:58 (opens in a new tab)

Documentskeleton Drawing