@univerjs/core v0.5.0-beta.1 • Docs

Class: SlideDataModel

The base class for all units.

Extends

UnitModel<ISlideData, UniverInstanceType.UNIVER_SLIDE>

Constructors

new SlideDataModel()

new SlideDataModel(snapshot): SlideDataModel

Parameters

Parameter	Type
`snapshot`	`Partial`<`ISlideData`>

Returns

SlideDataModel

Overrides

UnitModel.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:52

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`UnitModel`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`activePage$`	`readonly`	`Observable`<`Nullable`<`ISlidePage`>>	`undefined`	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:43
`name$`	`public`	`Observable`<`string`>	`undefined`	`UnitModel`.`name$`	-	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:46
`type`	`public`	`UNIVER_SLIDE`	`UniverInstanceType.UNIVER_SLIDE`	`UnitModel`.`type`	-	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:26

Methods

appendPage()

appendPage(page): void

Parameters

Parameter	Type
`page`	`ISlidePage`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:145

dispose()

dispose(): void

Returns

void

Inherited from

UnitModel.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:106

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

UnitModel.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

UnitModel.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100

getActivePage()

getActivePage(): Nullable<ISlidePage>

Returns

Nullable<ISlidePage>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:135

getBlankPage()

getBlankPage(): {
  description: '';
  id: string;
  pageBackgroundFill: {
     rgb: 'rgb(255,255,255)';
    };
  pageElements: {};
  pageType: PageType.SLIDE;
  title: id;
  zIndex: 10;
}

Returns

{
  description: '';
  id: string;
  pageBackgroundFill: {
     rgb: 'rgb(255,255,255)';
    };
  pageElements: {};
  pageType: PageType.SLIDE;
  title: id;
  zIndex: 10;
}

Name	Type	Default value	Defined in
`description`	`string`	”	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:121
`id`	`string`	-	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:117
`pageBackgroundFill`	{ `rgb`: `'rgb(255,255,255)'`; }	-	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:122
`pageBackgroundFill.rgb`	`string`	’rgb(255,255,255)‘	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:123
`pageElements`	{}	{}	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:125
`pageType`	`PageType`	PageType.SLIDE	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:118
`title`	`string`	id	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:120
`zIndex`	`number`	10	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:119

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:113

getElement()

getElement(pageId, elementId): undefined | IPageElement

Parameters

Parameter	Type
`pageId`	`string`
`elementId`	`string`

Returns

undefined | IPageElement

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:105

getElementsByPage()

getElementsByPage(pageId): undefined | {}

Parameters

Parameter	Type
`pageId`	`string`

Returns

undefined | {}

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:101

getPage()

getPage(pageId): undefined | ISlidePage

Parameters

Parameter	Type
`pageId`	`string`

Returns

undefined | ISlidePage

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:96

getPageOrder()

getPageOrder(): undefined | string[]

Returns

undefined | string[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:92

getPages()

getPages(): undefined | {}

Returns

undefined | {}

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:88

getPageSize()

getPageSize(): ISize

Returns

ISize

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:109

getRev()

getRev(): number

Get revision of the unit’s snapshot. Note that revision should start from 1.

Returns

number

Overrides

UnitModel.getRev

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:68

getSnapshot()

getSnapshot(): ISlideData

Returns

ISlideData

Overrides

UnitModel.getSnapshot

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:80

getUnitId()

getUnitId(): string

Returns

string

Overrides

UnitModel.getUnitId

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:84

incrementRev()

incrementRev(): void

Increment the current revision.

Returns

void

Overrides

UnitModel.incrementRev

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:72

setActivePage()

setActivePage(page): void

Parameters

Parameter	Type
`page`	`Nullable`<`ISlidePage`>

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:131

setName()

setName(name): void

Parameters

Parameter	Type
`name`	`string`

Returns

void

Overrides

UnitModel.setName

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:62

setRev()

setRev(_rev): void

Set revision of the current snapshot.

Parameters

Parameter	Type
`_rev`	`number`

Returns

void

Overrides

UnitModel.setRev

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:76

updatePage()

updatePage(pageId, page): void

Parameters

Parameter	Type
`pageId`	`string`
`page`	`ISlidePage`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/slides/slide-model.ts:139

Sheetviewmodel Styles