BlockSuite API Documentation / @blocksuite/blocks / DocPageService

Class: DocPageService

Extends

• PageService

Constructors

new DocPageService(options)

new DocPageService(options): DocPageService

Parameters

• options: BlockServiceOptions

Returns

DocPageService

Inherited from

@blocksuite/blocks.PageService.constructor

Source

packages/framework/block-std/dist/service/index.d.ts:16

Properties

disposables

readonly disposables: DisposableGroup

Inherited from

@blocksuite/blocks.PageService.disposables

Source

packages/framework/block-std/dist/service/index.d.ts:14

---

editSession

readonly editSession: EditSessionStorage

Inherited from

@blocksuite/blocks.PageService.editSession

Source

packages/blocks/src/page-block/page-service.ts:49

---

exportManager

exportManager: ExportManager

Inherited from

@blocksuite/blocks.PageService.exportManager

Source

packages/blocks/src/page-block/page-service.ts:52

---

fileDropManager

fileDropManager: FileDropManager

Inherited from

@blocksuite/blocks.PageService.fileDropManager

Source

packages/blocks/src/page-block/page-service.ts:51

---

flavour

readonly flavour: string

Inherited from

@blocksuite/blocks.PageService.flavour

Source

packages/framework/block-std/dist/service/index.d.ts:13

---

fontLoader

readonly fontLoader: FontLoader

Inherited from

@blocksuite/blocks.PageService.fontLoader

Source

packages/blocks/src/page-block/page-service.ts:48

---

slots

slots: Object

Type declaration

pageLinkClicked

pageLinkClicked: Slot<Object>

Type declaration

blockId?

blockId?: string

pageId

pageId: string

tagClicked

tagClicked: Slot<Object>

Type declaration

tagId

tagId: string

viewportUpdated

viewportUpdated: Slot<Viewport>

Source

packages/blocks/src/page-block/doc/doc-page-service.ts:7

---

specSlots

readonly specSlots: BlockSpecSlots

Inherited from

@blocksuite/blocks.PageService.specSlots

Source

packages/framework/block-std/dist/service/index.d.ts:15

---

std

readonly std: BlockStdScope

Inherited from

@blocksuite/blocks.PageService.std

Source

packages/framework/block-std/dist/service/index.d.ts:12

---

transformers

transformers: Object

Type declaration

html

html: Object = HtmlTransformer

html.exportPage

html.exportPage: (page) => Promise<void>

Parameters

• page: Page

Returns

Promise<void>

markdown

markdown: Object = MarkdownTransformer

markdown.exportPage

markdown.exportPage: (page) => Promise<void>

Parameters

• page: Page

Returns

Promise<void>

markdown.importMarkdown

markdown.importMarkdown: (__namedParameters) => Promise<void>

Parameters

• __namedParameters: ImportMarkdownOptions

Returns

Promise<void>

zip

zip: Object = ZipTransformer

zip.exportPages

zip.exportPages: (workspace, pages) => Promise<Blob>

Parameters

• workspace: Workspace

• pages: Page[]

Returns

Promise<Blob>

zip.importPages

zip.importPages: (workspace, imported) => Promise<Page[]>

Parameters

• workspace: Workspace

• imported: Blob

Returns

Promise<Page[]>

Inherited from

@blocksuite/blocks.PageService.transformers

Source

packages/blocks/src/page-block/page-service.ts:54

Accessors

getPageMode

get getPageMode(): (pageId) => "edgeless" | "page"

set getPageMode(value): void

Parameters

• value: (pageId) => "edgeless" | "page"

Returns

Function

Parameters

• pageId: string

Returns

"edgeless" | "page"

Source

packages/blocks/src/page-block/page-service.ts:81

---

getPageUpdatedAt

get getPageUpdatedAt(): (pageId) => Date

set getPageUpdatedAt(value): void

Parameters

• value: (pageId) => Date

Returns

Function

Parameters

• pageId: string

Returns

Date

Source

packages/blocks/src/page-block/page-service.ts:91

---

page

get page(): Page

Returns

Page

Source

packages/framework/block-std/dist/service/index.d.ts:18

---

selectedBlocks

get selectedBlocks(): BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Returns

BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Source

packages/blocks/src/page-block/page-service.ts:210

---

selectedModels

get selectedModels(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/blocks/src/page-block/page-service.ts:229

---

selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Source

packages/framework/block-std/dist/service/index.d.ts:19

---

uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Source

packages/framework/block-std/dist/service/index.d.ts:20

---

viewportElement

get viewportElement(): HTMLElement

Returns

HTMLElement

Source

packages/blocks/src/page-block/page-service.ts:68

---

workspace

get workspace(): Workspace

Returns

Workspace

Source

packages/framework/block-std/dist/service/index.d.ts:17

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?: Object

• options.global?: boolean

Returns

void

Inherited from

@blocksuite/blocks.PageService.bindHotKey

Source

packages/framework/block-std/dist/service/index.d.ts:27

---

dispose()

dispose(): void

Returns

void

Inherited from

@blocksuite/blocks.PageService.dispose

Source

packages/framework/block-std/dist/service/index.d.ts:21

---

getEmbedBlockOptions()

getEmbedBlockOptions(url): null | EmbedOptions

Parameters

• url: string

Returns

null | EmbedOptions

Inherited from

@blocksuite/blocks.PageService.getEmbedBlockOptions

Source

packages/blocks/src/page-block/page-service.ts:105

---

handleEvent()

handleEvent(name, fn, options?): void

Parameters

• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"

• fn: UIEventHandler

• options?: Object

• options.global?: boolean

Returns

void

Inherited from

@blocksuite/blocks.PageService.handleEvent

Source

packages/framework/block-std/dist/service/index.d.ts:24

---

loadFonts()

loadFonts(): void

Returns

void

Inherited from

@blocksuite/blocks.PageService.loadFonts

Source

packages/blocks/src/page-block/page-service.ts:233

---

mounted()

mounted(): void

Returns

void

Inherited from

@blocksuite/blocks.PageService.mounted

Source

packages/blocks/src/page-block/page-service.ts:118

---

registerEmbedBlockOptions()

registerEmbedBlockOptions(options): void

Parameters

• options: EmbedOptions

Returns

void

Inherited from

@blocksuite/blocks.PageService.registerEmbedBlockOptions

Source

packages/blocks/src/page-block/page-service.ts:101

---

unmounted()

unmounted(): void

Returns

void

Inherited from

@blocksuite/blocks.PageService.unmounted

Source

packages/blocks/src/page-block/page-service.ts:114

---

Generated using TypeDoc and typedoc-plugin-markdown.