Class: DocumentViewModel

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:177

Implements

IDisposable

Constructors

new DocumentViewModel()

new DocumentViewModel(_documentDataModel): DocumentViewModel

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:207

Parameters

Parameter	Type
`_documentDataModel`	`DocumentDataModel`

Returns

DocumentViewModel

Properties

Property	Modifier	Type	Defined in
`editAreaChange$`	`readonly`	`Observable`<`Nullable`<`DocumentEditArea`>>	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:199
`segmentViewModels$`	`readonly`	`Observable`<`DocumentViewModel`[]>	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:205

Methods

dispose()

dispose(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:229

Returns

void

Implementation of

IDisposable.dispose

findTableNodeById()

findTableNodeById(id): undefined | DataStreamTreeNode

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:343

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | DataStreamTreeNode

getBody()

getBody(): undefined | IDocumentBody

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:264

Returns

undefined | IDocumentBody

getChildren()

getChildren(): DataStreamTreeNode[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:260

Returns

DataStreamTreeNode[]

getCustomBlock()

getCustomBlock(index): undefined | ICustomBlock

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:322

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ICustomBlock

getCustomBlockWithoutSetCurrentIndex()

getCustomBlockWithoutSetCurrentIndex(index): undefined | ICustomBlock

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:326

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ICustomBlock

getCustomDecoration()

getCustomDecoration(index): Nullable<ICustomDecorationForInterceptor>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:383

Parameters

Parameter	Type
`index`	`number`

Returns

Nullable<ICustomDecorationForInterceptor>

getCustomDecorationRaw()

getCustomDecorationRaw(index): 
  | undefined
  | ICustomDecoration

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:369

Parameters

Parameter	Type
`index`	`number`

Returns

| undefined | ICustomDecoration

getCustomRange()

getCustomRange(index): Nullable<ICustomRangeForInterceptor>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:361

Parameters

Parameter	Type
`index`	`number`

Returns

Nullable<ICustomRangeForInterceptor>

getCustomRangeRaw()

getCustomRangeRaw(index): undefined | ICustomRange

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:347

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ICustomRange

getDataModel()

getDataModel(): DocumentDataModel

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:272

Returns

DocumentDataModel

getEditArea()

getEditArea(): DocumentEditArea

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:249

Returns

DocumentEditArea

getHeaderFooterTreeMap()

getHeaderFooterTreeMap(): {
  footerTreeMap: Map<string, DocumentViewModel>;
  headerTreeMap: Map<string, DocumentViewModel>;
}

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:242

Returns

{
  footerTreeMap: Map<string, DocumentViewModel>;
  headerTreeMap: Map<string, DocumentViewModel>;
}

Name	Type	Defined in
`footerTreeMap`	`Map`<`string`, `DocumentViewModel`>	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:245
`headerTreeMap`	`Map`<`string`, `DocumentViewModel`>	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:244

getParagraph()

getParagraph(index): undefined | IParagraph

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:311

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | IParagraph

getSectionBreak()

getSectionBreak(index): undefined | ISectionBreak

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:307

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ISectionBreak

getSelfOrHeaderFooterViewModel()

getSelfOrHeaderFooterViewModel(segmentId?): DocumentViewModel

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:276

Parameters

Parameter	Type
`segmentId`?	`string`

Returns

DocumentViewModel

getSnapshot()

getSnapshot(): IDocumentData

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:268

Returns

IDocumentData

getTableByStartIndex()

getTableByStartIndex(index): undefined | ITableCoupleCache

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:339

Parameters

Parameter	Type
`index`	`number`

Returns

undefined | ITableCoupleCache

getTextRun()

getTextRun(index): Nullable<ITextRun>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:315

Parameters

Parameter	Type
`index`	`number`

Returns

Nullable<ITextRun>

registerCustomRangeInterceptor()

registerCustomRangeInterceptor(interceptor): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:223

Parameters

Parameter	Type
`interceptor`	`ICustomRangeInterceptor`

Returns

IDisposable

reset()

reset(documentDataModel): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:292

Parameters

Parameter	Type
`documentDataModel`	`DocumentDataModel`

Returns

void

setEditArea()

setEditArea(editArea): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/view-model/document-view-model.ts:253

Parameters

Parameter	Type
`editArea`	`DocumentEditArea`

Returns

void

Documentskeleton Documents