@univerjs/core v0.1.17 • Docs
Class: DocumentDataModel
Extends
DocumentDataModelSimple
Constructors
new DocumentDataModel()
new DocumentDataModel(snapshot): DocumentDataModel
Parameters
Parameter | Type |
---|---|
snapshot | Partial <IDocumentData > |
Returns
Overrides
DocumentDataModelSimple.constructor
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:208 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | DocumentDataModelSimple._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
footerModelMap | public | Map <string , DocumentDataModel > | undefined | - | submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:206 (opens in a new tab) |
headerModelMap | public | Map <string , DocumentDataModel > | undefined | - | submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:204 (opens in a new tab) |
snapshot | protected | IDocumentData | undefined | DocumentDataModelSimple.snapshot | submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:52 (opens in a new tab) |
type | public | UNIVER_DOC | UniverInstanceType.UNIVER_DOC | DocumentDataModelSimple.type | submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:46 (opens in a new tab) |
Accessors
documentStyle
get documentStyle(): IDocumentStyle
Returns
Inherited from
DocumentDataModelSimple.documentStyle
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:64 (opens in a new tab)
drawings
get drawings(): undefined | IDrawings
Returns
undefined
| IDrawings
Inherited from
DocumentDataModelSimple.drawings
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:60 (opens in a new tab)
lists
get lists(): undefined | ILists
Returns
undefined
| ILists
Inherited from
DocumentDataModelSimple.lists
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:68 (opens in a new tab)
zoomRatio
get zoomRatio(): number
Returns
number
Inherited from
DocumentDataModelSimple.zoomRatio
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:72 (opens in a new tab)
Methods
apply()
apply(actions):
| undefined
| null
| string
| number
| boolean
| Doc[]
| {}
Parameters
Parameter | Type |
---|---|
actions | JSONOp |
Returns
| undefined
| null
| string
| number
| boolean
| Doc
[]
| {}
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:276 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
DocumentDataModelSimple.dispose
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:218 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
DocumentDataModelSimple.disposeWithMe
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
DocumentDataModelSimple.ensureNotDisposed
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getBody()
getBody(): undefined | IDocumentBody
Returns
undefined
| IDocumentBody
Inherited from
DocumentDataModelSimple.getBody
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:81 (opens in a new tab)
getContainer()
getContainer(): undefined | string
Returns
undefined
| string
Inherited from
DocumentDataModelSimple.getContainer
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:91 (opens in a new tab)
getDrawings()
getDrawings(): undefined | IDrawings
Returns
undefined
| IDrawings
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:228 (opens in a new tab)
getDrawingsOrder()
getDrawingsOrder(): undefined | string[]
Returns
undefined
| string
[]
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:232 (opens in a new tab)
getRev()
getRev(): number
Returns
number
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:236 (opens in a new tab)
getSelfOrHeaderFooterModel()
getSelfOrHeaderFooterModel(segmentId?): DocumentDataModel
Parameters
Parameter | Type |
---|---|
segmentId ? | string |
Returns
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:258 (opens in a new tab)
getSettings()
getSettings(): undefined | IDocumentSettings
Returns
undefined
| IDocumentSettings
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:244 (opens in a new tab)
getShouldRenderLoopImmediately()
getShouldRenderLoopImmediately(): boolean
Returns
boolean
Inherited from
DocumentDataModelSimple.getShouldRenderLoopImmediately
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:85 (opens in a new tab)
getSnapshot()
getSnapshot(): IDocumentData
Returns
Inherited from
DocumentDataModelSimple.getSnapshot
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:95 (opens in a new tab)
getUnitId()
getUnitId(): string
Returns
string
Overrides
DocumentDataModelSimple.getUnitId
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:272 (opens in a new tab)
incrementRev()
incrementRev(): void
Returns
void
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:240 (opens in a new tab)
reset()
reset(snapshot): void
Parameters
Parameter | Type |
---|---|
snapshot | Partial <IDocumentData > |
Returns
void
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:249 (opens in a new tab)
resetDrawing()
resetDrawing(drawings, drawingsOrder): void
Parameters
Parameter | Type |
---|---|
drawings | IDrawings |
drawingsOrder | string [] |
Returns
void
Inherited from
DocumentDataModelSimple.resetDrawing
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:76 (opens in a new tab)
setZoomRatio()
setZoomRatio(zoomRatio): void
Parameters
Parameter | Type | Default value |
---|---|---|
zoomRatio | number | 1 |
Returns
void
Inherited from
DocumentDataModelSimple.setZoomRatio
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:190 (opens in a new tab)
sliceBody()
sliceBody(startOffset, endOffset): Nullable<IDocumentBody>
Parameters
Parameter | Type |
---|---|
startOffset | number |
endOffset | number |
Returns
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:284 (opens in a new tab)
updateDocumentDataMargin()
updateDocumentDataMargin(data): void
Parameters
Parameter | Type |
---|---|
data | IPaddingData |
Returns
void
Inherited from
DocumentDataModelSimple.updateDocumentDataMargin
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:127 (opens in a new tab)
updateDocumentDataPageSize()
updateDocumentDataPageSize(width?, height?): void
Parameters
Parameter | Type |
---|---|
width ? | number |
height ? | number |
Returns
void
Inherited from
DocumentDataModelSimple.updateDocumentDataPageSize
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:148 (opens in a new tab)
updateDocumentId()
updateDocumentId(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Overrides
DocumentDataModelSimple.updateDocumentId
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:312 (opens in a new tab)
updateDocumentRenderConfig()
updateDocumentRenderConfig(config): void
Parameters
Parameter | Type |
---|---|
config | IDocumentRenderConfig |
Returns
void
Inherited from
DocumentDataModelSimple.updateDocumentRenderConfig
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:103 (opens in a new tab)
updateDocumentStyle()
updateDocumentStyle(config): void
Parameters
Parameter | Type |
---|---|
config | IDocumentStyle |
Returns
void
Inherited from
DocumentDataModelSimple.updateDocumentStyle
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:116 (opens in a new tab)
updateDrawing()
updateDrawing(id, config): void
Parameters
Parameter | Type |
---|---|
id | string |
config | IDrawingUpdateConfig |
Returns
void
Inherited from
DocumentDataModelSimple.updateDrawing
Defined in
submodules/univer/packages/core/src/docs/data-model/document-data-model.ts:172 (opens in a new tab)